APIでの利用方法

共有セーブ

編集

APIでの利用方法

共有セーブの取得

メソッドwindow.RPGAtsumaru.storage.getSharedItems(userIds: number[], gameId?: number)
説明指定したユーザの Atsumaru Shared というキーで保存したセーブデータを取得する。
引数
  • userIds : 共有セーブを取得したいユーザーのニコニコユーザーIDの配列を自然数で、最大100件まで指定します。
  • gameId : 現在プレイ中のゲーム以外からセーブデータを取得する場合、ゲームのIDを自然数で指定します。
戻り値Promise<SharedSaveItems>
  • userIds で指定したユーザーのセーブデータユーザーのデータを取得できます。
  • 第二引数の gameId を指定することで、別のゲームの共有セーブを取得できます。

戻り値の型 SharedSaveItems について

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

interface SharedSaveItems {
    [userId: number]: string;
}

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

プロパティ内容
[userId: number]stringuserId のIDのユーザーの共有セーブデータを収納します。

戻り値の例

// window.RPGAtsumaru.storage.getSharedItems([123, 456, 789]).then(function(v) { console.log(v) }) を実行
{
    123: "ユーザー123の共有データ",
    456: "ユーザー456の共有データ"
    // 789 のユーザーが取得先のゲームで「プレイヤー間通信の有効化」されていない場合は結果に含まれません!
}

起こりうるエラーの種類

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

関連ドキュメント

ドキュメントリンク備考
機能解説共有セーブ機能概要や全般的な解説
プラグインでの利用方法プラグインでの利用方法RPGツクールシリーズユーザー向け

最終更新日

  • 2020/02/28