モジュール：リーダーボード
プラットフォーム：Facebookはグローバル リーダーボードをサポートしていません。そのため、すべてのリーダーボード名には、現在の contextID を追加する必要があります。Facebookのリーダーボード API を使用するには、コンテキスト内で実行しなければなりません。
目次
機能
- getConnectedPlayersEntriesAsync
- getEntriesAsync
- getEntryCountAsync
- getLeaderboardAsync
- getPlayerEntryAsync
- sendEntryAsync
機能
getConnectedPlayersEntriesAsync
▸ getConnectedPlayersEntriesAsync(name, count, offset): Promise<LeaderboardEntry[]>
現在のプレーヤーと、そのプレイヤーに繋がっているプレイヤーたちのリーダーボードのローカルランキングリストをランク順に取得します。
例
Wortal.leaderboard.getConnectedPlayersEntriesAsync('global')
.then(entries => console.log(entries));
パラメーター
| 名前 | タイプ | 内容説明 |
|---|---|---|
name |
string |
内容説明 |
count |
number |
リーダーボードから取得しようとするエントリーの数。指定しない場合、デフォルトは ”10” となります。現在、1回のクエリで最大100エントリまでフェッチが可能です。 |
offset |
number |
順番に連結されたプレーヤーのスコア・エントリーのセットからフェッチするオフセット。 |
Returns
Promise<LeaderboardEntry[]>
クエリに一致するリーダーボードのエントリで解決する Promise。
Throws
- NOT_SUPPORTED
- INVALID_PARAM
- NETWORK_FAILURE
- RATE_LIMITED
getEntriesAsync
▸ getEntriesAsync(name, count, offset?): Promise<LeaderboardEntry[]>
リーダーボードのエントリ一覧を高得点順に取得します。
例
パラメーター
| 名前 | タイプ | 内容説明 |
|---|---|---|
name |
string |
リーダーボード名。 |
count |
number |
リーダーボードから取得しようとするエントリーの数。指定しない場合、デフォルトは ”10” となります。現在、1回のクエリで最大100エントリまでフェッチが可能です。 |
offset? |
number |
順番に連結されたプレーヤーのスコア・エントリーのセットからフェッチするオフセット。 |
Returns
Promise<LeaderboardEntry[]>
クエリに一致するリーダーボードのエントリで解決する Promise。
Throws
- NOT_SUPPORTED
- INVALID_PARAM
- NETWORK_FAILURE
- RATE_LIMITED
getEntryCountAsync
▸ getEntryCountAsync(name): Promise<number>
クエリに一致するリーダーボードのエントリで解決します。
例
パラメーター
| 名前 | タイプ | 内容説明 |
|---|---|---|
name |
string |
リーダーボード名。 |
Returns
Promise<number>
エントリー数で解決する Promise。
Throws
- NOT_SUPPORTED
- INVALID_PARAM
- NETWORK_FAILURE
- RATE_LIMITED
getLeaderboardAsync
▸ getLeaderboardAsync(name): Promise<Leaderboard>
このゲームに属する特定のリーダーボードを取得します。
例
Wortal.leaderboard.getLeaderboardAsync('global')
.then(leaderboard => console.log(leaderboard.name()));
パラメーター
| 名前 | タイプ | 内容説明 |
|---|---|---|
name |
string |
リーダーボード名。ゲームの各リーダーボードには、明確な名前が必要です。 |
Returns
Promise<Leaderboard>
一致するリーダーボードで解決する Promise 。見つからない場合は拒否されます。
Throws
- NOT_SUPPORTED
- LEADERBOARD_NOT_FOUND
- NETWORK_FAILURE
- CLIENT_UNSUPPORTED_OPERATION
- INVALID_OPERATION
- INVALID_PARAM
getPlayerEntryAsync
▸ getPlayerEntryAsync(name): Promise<LeaderboardEntry>
現在のプレイヤーが設定したリーダーボードのエントリを取得します。設定されていない場合、Nullを戻します。
例
パラメーター
| 名前 | タイプ | 内容説明 |
|---|---|---|
name |
string |
リーダーボード名。 |
Returns
Promise<LeaderboardEntry>
プレイヤーの現在のリーダーボードのエントリで解決する Promise。
Throws
- NOT_SUPPORTED
- INVALID_PARAM
- INVALID_OPERATION
- NETWORK_FAILURE
- RATE_LIMITED
sendEntryAsync
▸ sendEntryAsync(name, score, details?): Promise<LeaderboardEntry>
プレイヤーのスコアを更新します。新しいスコアが既存のスコアを上回る場合のみ、スコアが更新されます。 注：プレイヤーのスコアを設定する際にリーダーボードが特定のコンテキストに関連付けられている場合、そのコンテキストにゲームが含まれている必要があります。
例
パラメーター
| 名前 | タイプ | 内容説明 |
|---|---|---|
name |
string |
リーダーボード名。 |
score |
number |
エントリのスコア。64ビット整数値でなければなりません。 |
details? |
string |
保存されたスコアに関連付けるメタデータオプション。サイズは2KB以下でなければなりません。 |
Returns
Promise<LeaderboardEntry>
アップデート後のプレイヤーの現在のリーダーボードのエントリで解決する Promise。
Throws
- NOT_SUPPORTED
- LEADERBOARD_WRONG_CONTEXT
- NETWORK_FAILURE
- CLIENT_UNSUPPORTED_OPERATION
- INVALID_PARAM
- INVALID_OPERATION
- RATE_LIMITED