スコアボード
編集目次
プラグインの利用方法
プラグインでスコアボードを利用するには以下のようにします。
- プラグインのダウンロード：AtsumaruScoreboards.js を右クリックで「名前をつけて保存」してダウンロード
- プロジェクトに追加：ダウンロードしたファイルをプロジェクトのプラグインフォルダに設置
- 有効化：プロジェクトのプラグイン設定でプラグインをONにする
機能の呼び出し
スコアボードへの記録
公式プラグインを利用してスコアボードへの記録を行う場合、プラグインコマンドで次のいずれかのように指定します（どちらでも動作は同じです）。
SetRecordToScoreboard <boardId> <variableId>あるいは
スコア送信 <boardId> <variableId><boardId> にはスコアを記録したいスコアボードのIDを半角数字で指定してください。また、 <variableId> にはスコアが格納されている変数のIDを記載してください。スコアの値としてRPGアツマールがサポートしている範囲は -999,999,999,999,999 ～ +999,999,999,999,999 です。
スコアボードへの記録：応用
スコアボードへの記録を行いながら、記録に成功したかチェックする場合、プラグインコマンドで次のいずれかのように指定します（どちらでも動作は同じです）。
SetRecordToScoreboard <boardId> <variableId> <errorVariableId>あるいは
スコア送信 <boardId> <variableId> <errorVariableId>記録に失敗した場合、<errorVariableId>で指定されたIDの変数にエラーメッセージがセットされます。記録に成功した場合は、単に0がセットされます。
スコアボードの表示
公式プラグインを利用してスコアボードへの記録を行う場合、プラグインコマンドで次のいずれかのように指定します（どちらでも動作は同じです）。
DisplayScoreboard <boardId>あるいは
記録に失敗した場合、`<errorVariableId>`で指定されたIDの変数にエラーメッセージがセットされます。記録に成功した場合は、単に0がセットされます。<boardId>には表示したスコアボードのIDを半角数字で指定してください。
スコアボード内の情報利用
スコアボード内に格納されている情報を利用するには、事前に上述の方法でスコアボードからデータを読み込み、下記の方法で利用する情報をターゲットとして指定し変数に格納してください。
公式プラグインを利用してスコアボード内の情報を変数に格納するには、プラグインコマンドで次のいずれかのように指定します。（どちらでも動作は同じです）
GetDataFromScoreboardRecords <target> <variableId>あるいは
スコア取得 <target> <variableId><target>には取得したいターゲットを指定(下部に利用できるターゲットを記載)。<variableId>には格納したい変数のIDを指定してください。
利用できるターゲットの一覧
| ターゲット | 説明 |
|---|---|
| myRecord | 今回の自己レコードの有無を取得。ある場合は1、ない場合は0がセットされる |
| myRecord.rank | 今回の自己レコードのランキング順位を取得。ない場合は0がセットされる |
| myRecord.score | 今回の自己レコードのスコアを取得。ない場合は0がセットされる |
| myRecord.isNewRecord | 今回の自己レコードが自己新記録かどうかを取得。自己新記録なら1、そうでない場合は0がセットされる |
| myBestRecord | 自己ベスト記録の有無を取得。ある場合は1、ない場合（または非ログイン）は0がセットされる |
| myBestRecord.rank | 自己ベスト記録のランキング順位を取得。ない場合（または非ログイン）は0がセットされる |
| myBestRecord.score | 自己ベスト記録のスコアを取得。ない場合（または非ログイン）は0がセットされる |
| ranking.length | ランキングデータの長さの取得 |
| ranking[n].rank | n+1番目のランキングを取得 |
| ranking[n].userName | n+1番目のランクのユーザ名を取得 |
| ranking[n].score | n+1番目のランクのスコアを取得 |
| errorMessage | スコアの読み込みに失敗した場合、エラーメッセージを取得する。成功した場合は0がセットされる |
関連ドキュメント
| ドキュメント | リンク | 備考 |
|---|---|---|
| 機能解説 | スコアボード | 機能概要や全般的な解説 |
| APIでの利用方法 | スコアボード | 他ゲームエンジンやより高度な利用を必要とするユーザー向け |
最終更新日
- 2020/02/28