グローバルサーバー変数APIを利用する

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

APIを使ったグローバルサーバー変数の利用方法について解説します。予め、グローバルサーバー変数設定画面で変数及びトリガーの設定を済ませておく必要があります。

グローバルサーバー変数取得

グローバルサーバー変数のIDを指定し、現在値、最大値、最小値、変数名を取得します。

メソッドwindow.RPGAtsumaru.experimental.globalServerVariable.getGlobalServerVariable(globalServerVariableId: number)
説明引数に指定した globalServerVariableId のグローバルサーバー変数の情報を取得する
引数グローバルサーバー変数ID (自然数) ※グローバルサーバー変数設定画面で設定
戻り値Promise<GlobalServerVariableData>
リリース日2018/12/17
更新日2018/12/17

戻り値の型 GlobalServerVariableData について

戻り値で取得できる GlobalServerVariableData は以下のような型です。

interface GlobalServerVariableData {
  name: string,
  maxValue: number,
  minValue: number,
  value: number
}

プロパティの内容は次のようになっています。

プロパティ名内容
valuenumberグローバルサーバー変数の現在値
minValuenumberグローバルサーバー変数の最小値
maxValuenumberグローバルサーバー変数の最大値
namestringグローバルサーバー変数の変数名

戻り値の例

// window.RPGAtsumaru.experimental.globalServerVariable.getGlobalServerVariable(1).then(function(v) { console.log(v) }) を実行
{
  "name": "レイドボスHP",
  "maxValue": 10000,
  "minValue": 0,
  "value": 1234
}

起こりうるエラーの種類

名前説明
BAD_REQUEST
  • 指定したグローバルサーバー変数IDがそのゲームのものではない
  • 引数として不正な値を指定している
INTERNAL_SERVER_ERRORRPGアツマールのサービス側で何らかの問題が発生しているか、または通信に失敗した
API_CALL_LIMIT_EXCEEDED短時間にRPGアツマール ゲームAPIを利用しすぎて、一時的に利用を制限されている

トリガー発動

予め設定したトリガーIDを指定して、グローバルサーバー変数の値を変化させます。

メソッドwindow.RPGAtsumaru.experimental.globalServerVariable.triggerCall(triggerId:number, delta?: number)
説明引数に指定したtriggeridのトリガーを発動させる
引数
戻り値Promise<void>
リリース日2018/12/17
更新日2018/12/17
  • 引数 delta はトリガーの種別が「ゲーム内で増減値を指定して実行」のときのみ指定可能です。 -「ゲーム内から実行」トリガーの場合は指定しないでください。

起こりうるエラーの種類

名前説明
BAD_REQUEST
  • 指定したトリガーIDがそのゲームのものではない
  • 「ゲーム内から実行」トリガーで delta を指定した
  • 「ゲーム内で増減値を指定して実行」トリガーで delta を省略した
  • 引数として不正な値を指定している
INTERNAL_SERVER_ERRORRPGアツマールのサービス側で何らかの問題が発生しているか、または通信に失敗した
API_CALL_LIMIT_EXCEEDED短時間にゲームAPIを利用しすぎて、一時的に利用を制限されている