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

解説

イベントに基づく統計

イベントベースの Stats で statName メンバーを使用する場合、値は stat インスタンスと一致する必要があります。

タイトルで管理される統計

リーダーボードに [タイトルで管理される統計] を使用する場合、skipToXboxUserId をゼロ以外の値として設定すると、指定された xboxUserId の保存された統計がグローバルランキングと比較されます。

同様に、socialGroup を People または [お気に入り] として設定すると、指定された xboxUserId と関連付けられたユーザーの保存された統計が比較されます。グローバルランキングの値は使用しません。

プレーヤーの保存された統計とグローバルランキングのスコアが同じでない場合、出力が一致しない可能性があることに注意してください。

要件

ヘッダー: leaderboard_c.h

次の方法で共有