スコアボードプラグインを利用する

編集
この機能は実験的な機能であり、将来仕様が変更される可能性があります。予めご了承ください。

公式プラグインの利用方法

公式プラグインでスコアボードを設置するには次のようにします。

  1. プロジェクトのプラグインフォルダに AtsumaruScoreboardsExperimental.js を右クリックし「保存」して設置
  2. イベントに記録・取得・表示イベントの設定
  3. プラグインコマンドでスコアの記録・取得・表示

スコアボードへの記録

スコアボードへの記録


公式プラグインを利用してスコアボードへの記録を行う場合、プラグインコマンドで次のいずれかのように指定します(どちらでも動作は同じです)。

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}
スコア表示 {boardId}

{boardId}には表示したスコアボードのIDを半角数字で指定してください。

スコアボードのデータの読み込み

スコアボード内の情報を取得し利用するには、

  1. スコアボードからデータの読み込み
  2. 利用する情報を指定(ターゲットの指定)して変数に格納

の手順が必要です。

公式プラグインを利用してスコアボード内の情報を取得するには、プラグインコマンドで次のいずれかのように指定します。(どちらでも動作は同じです)

FetchRecordsFromScoreboard {boardId}
スコア受信 {boardId}

{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].rankn+1番目のランキングを取得
ranking[n].userNamen+1番目のランクのユーザ名を取得
ranking[n].scoren+1番目のランクのスコアを取得
errorMessageスコアの読み込みに失敗した場合、エラーメッセージを取得する。成功した場合は0がセットされる