rc_client_begin_fetch_leaderboard_entries_around_user

Fetches a list of leaderboard entries from the server centered around the logged in user.

Syntax

rc_client_async_handle_t* rc_client_begin_fetch_leaderboard_entries_around_user(
    rc_client_t* client,
    uint32_t leaderboard_id,
    uint32_t count,
    rc_client_fetch_leaderboard_entries_callback_t callback,
    void* callback_userdata
);

Parameters

client

The rc_client_t to use to fetch the leaderboard entries.

leaderboard_id

The unique identifier of the leaderboard to query.

count

The number of entries to retrieve.

callback

Function to call when the list is available.

callback_userdata

Additional information to pass to the callback function.

Returns

Pointer to an rc_client_async_handle_t that can be passed to rc_client_abort_async to cancel the leaderboard query request. The rc_client_async_handle_t is invalid after callback has been called.

Remarks

See rc_client_begin_fetch_leaderboard_entries for information about the data types.

The rc_client_leaderboard_list_t instance created by this function must be released by calling rc_client_destroy_leaderboard_entry_list.

The user's entry should be centered in the returned list unless the user is very near the top or bottom of the list. If 10 entries are requested, the user should be the fifth entry unless they are in the top four or bottom five users for the leaderboard. If the user isn't in the list at all, the top N entries will be returned.

Minimum version: 11.0.0

See also

rc_client_begin_fetch_leaderboard_entries

rc_client_destroy_leaderboard_entry_list

rc_client_leaderboard_entry_get_user_image_url