XblLeaderboardQuery

项目
06/23/2023

表示使用基于事件或基于游戏的统计信息提交排行榜查询的参数。

语法

typedef struct XblLeaderboardQuery {  
    uint64_t xboxUserId;  
    char scid[XBL_SCID_LENGTH];  
    const char* leaderboardName;  
    const char* statName;  
    XblSocialGroupType socialGroup;  
    const char** additionalColumnleaderboardNames;  
    size_t additionalColumnleaderboardNamesCount;  
    XblLeaderboardSortOrder order;  
    uint32_t maxItems;  
    uint64_t skipToXboxUserId;  
    uint32_t skipResultToRank;  
    const char* continuationToken;  
    XblLeaderboardQueryType queryType;  
} XblLeaderboardQuery

成员

xboxUserId
类型：uint64_t

发出请求的用户的可选 Xbox 用户 ID。如果执行全局排行榜，则设置为 0。

scid
类型：char[XBL_SCID_LENGTH]

游戏的 UTF-8 编码的服务配置 ID (SCID)。

leaderboardName
类型：const char*

要针对其获得排行榜的可选 UTF-8 编码的排行榜名称。如果查询社交排行榜或标题管理统计支持的排行榜，则设置为nullptr。

statName
类型：const char*

要针对其获得排行榜的可选 UTF-8 编码的统计信息名称。在查询社交排行榜或标题管理统计支持排行榜时使用。

socialGroup
类型：XblSocialGroupType

（可选）要获得排行榜结果的社交用户组。例如，要获得“仅好友”排行榜。设置为 XblSocialGroupType_None 以获取全局排行榜。

additionalColumnleaderboardNames
类型：const char**

（可选）其他列的统计信息的名称的 UTF-8 编码数组。

additionalColumnleaderboardNamesCount
类型：size_t

传入的 additionalColumnleaderboardNames 的可选计数。

order
类型：XblLeaderboardSortOrder

设置生成的排行榜的排序顺序。

maxItems
类型：uint32_t

设置生成的排行榜将包含的最大项目。设置为 0 以使服务返回默认的最大项目数。

skipToXboxUserId
类型：uint64_t

设置生成的排行榜将以哪个用户为中心。设置为 0 则不跳到特定用户。

skipResultToRank
类型：uint32_t

设置生成的排行榜将以哪个排名为中心。设置为 0 则不跳到特定排名。

continuationToken
类型：const char*

用于获取下一组排行榜数据的 UTF-8 编码的 continuationToken。

queryType
类型：XblLeaderboardQueryType

要查询的排行榜类型。

成员隶属于

XblLeaderboardResult

参数属于

XblLeaderboardGetLeaderboardAsync

备注

基于事件的统计信息

将 statName 成员与基于事件的统计信息一起使用时，该值应与统计信息实例一致。

游戏管理的统计信息

对排行榜使用游戏管理的统计信息时，将 skipToXboxUserId 设置为非零值后，会将给定的 xboxUserId 存储的统计信息与全球排行榜进行比较。

同样地，将 socialGroup 设置为“人员”或“收藏夹”后，将比较给定 xboxUserId 和关联用户的存储的统计信息。它不会使用全球排行榜的值。

请注意，当玩家存储的统计信息和其在全球排行榜上的分数不同时，可能会导致输出不匹配。

要求

头文件：leaderboard_c.h

另请参阅

leaderboard_c
基于事件的信息与游戏管理的统计信息的比较

通过