qBool GetRanking( ProtocolCallContext * pContext, RankingConstants::RankingMode rankingMode, qUnsignedInt32 category, const RankingOrderParam & orderParam, RankingResult * pResult, UniqueId nexUniqueId = INVALID_UNIQUEID, qUnsignedInt32 principalId = INVALID_PRINCIPALID );
Name | Description | |
---|---|---|
in | pContext | The call context. |
in | rankingMode | The ranking retrieval mode. |
in | category | Category. |
in | orderParam | Parameters for calculating the order. |
out | pResult | The obtained result of rankings. |
in | nexUniqueId | The NEX unique ID. |
in | principalId | The principal ID. |
Value | Description |
---|---|
true |
RMC call initialization succeeded. |
false |
Failure. |
Gets the ranking list.
Gets a ranking list for the specified category.
If RankingConstants::RANKING_MODE_RANGE
(the ranking range) is specified for rankingMode, the function gets a list of scores of the length specified by an offset from the range of rankings from first place to RankingConstants::MAX_RANGE_RANKING_ORDER
th place. You cannot specify an offset larger than RankingConstants::MAX_RANGE_RANKING_ORDER
- 1. In the range of rankings mode, the nexUniqueId and principalId values are ignored.
When RankingConstants::RANKING_MODE_NEAR
(nearby rankings) is specified for the ranking mode, the function gets a list of rankings in which the users with the specified principal ID and NEX unique ID are in the middle of the list. (The specified users are not in the middle of the list if they are in first or last place.) If nn::nex::INVALID_PRINCIPALID
is specified for principalId, the principal ID of the local host is used. There are no restrictions on getting rankings that are not in the range of rankings. Nearby rankings can be retrieved even if the ranking of the specified user is higher than RankingConstants::MAX_RANGE_RANKING_ORDER
. (When the user's ranking is higher than RankingConstants::MAX_ACCURATE_ORDER
, small calculation errors may occur because of when the ranking data is retrieved.) In the nearby rankings mode, the offset value specified by orderParam is ignored.
If RankingConstants::RANKING_MODE_FRIEND_RANGE
(friend rankings) is specified for the ranking mode, a list of the friends rankings for the local system and the ranking of the local host within that list is retrieved. If a player does not have any friends, this gets only that player's data. If the player and the friends of the player have scores that are associated with multiple NEX unique IDs all under the same principal ID, all of the ranking data that corresponds to those NEX unique IDs is included. In the friend rankings mode, the nexUniqueId and principalId values are ignored.
If RankingConstants::RANKING_MODE_FRIEND_NEAR
(nearby friend rankings) is specified for the ranking mode, a list of the nearby rankings for the friends of the local host and the ranking of the local host within that list is retrieved. If the local host has scores with multiple NEX unique IDs under the principal ID, the nearby friend ranking list is centered on the scores with the NEX unique IDs that were specified as arguments. In the nearby friend rankings mode, the principalId parameter and the offset specified by orderParam are ignored.
If RankingConstants::RANKING_MODE_USER
(get individual ranking data) is specified for the ranking mode, only ranking data for the user with the specified principal ID and NEX unique IDs is retrieved. The offset specified by orderParam is ignored.
CONFIDENTIAL