アツマールAPIの「共有セーブ」を利用するためのプラグイン – AtsumaruSharedSaveExperimental.js

タイトル
RPGアツマールの共有セーブのための(Experimental版)プラグイン
作者名
ヘルプ
このプラグインは、アツマールAPIの「共有セーブ」を利用するためのプラグインです。
詳しくはアツマールAPIリファレンス(https://atsumaru.github.io/api-references/shared-save)を参照してください。

プラグインコマンド(英語版と日本語版のコマンドがありますが、どちらも同じ動作です):
SetSharedSave
共有セーブ保存
# 共有セーブの保存範囲(開始-終了)で指定した範囲の変数を読み込み、
自分の共有セーブとして保存します。
# 例: SetSharedSave
# : 共有セーブ保存

GetSharedSave <userIdVariableId> <startVariableId>
共有セーブ取得 <userIdVariableId> <startVariableId>
# 変数<userIdVariableId>からユーザーIDを読み取り、
そのユーザーの共有セーブを<startVariableId>を先頭にして代入します。
# 例: GetSharedSave 1 201
# : 共有セーブ取得 1 201
(共有セーブの保存範囲が101-150で計50個の場合、変数1番に格納されたユーザーIDの人の共有セーブを201-250に代入)

アツマール外(テストプレイや他のサイト、ダウンロード版)での挙動:
SetSharedSave(共有セーブ保存)
無視される(エラーメッセージにも何も代入されない)
GetSharedSave(共有セーブ取得)
無視される(エラーメッセージにも何も代入されない)

備考:
・本プラグインは、共有セーブの保存領域をすべて使用します。
そのため、共有セーブを活用する他のプラグインと共存することはできません。
・ゲームを公開後に共有セーブの保存範囲を変更する時は、
古い保存範囲のセーブデータとの互換性にご注意ください。

※「並列処理」の中でプラグインコマンドを利用しますと
その時セーブしたセーブデータの状態が不確定になりますので、
可能な限り「並列処理」以外のトリガーでご利用ください。
パラメータ
param startVariableId
type variable
text 共有セーブの保存範囲(開始)
desc 「共有セーブ保存」コマンドで保存する変数の番号を指定します。
default 0

param finishVariableId
type variable
text 共有セーブの保存範囲(終了)
desc 「共有セーブ保存」コマンドで保存する変数の番号を指定します。
default 0

param errorMessage
type variable
text エラーメッセージ
desc エラーが発生した場合に、エラーメッセージを代入する変数の番号を指定します。
default 0

ライセンス表記
Copyright (c) 2018-2019 RPGアツマール開発チーム(https://game.nicovideo.jp/atsumaru)
Released under the MIT license
http://opensource.org/licenses/mit-license.php

紹介ページ https://github.com/atsumaru/mv-plugins/blob/master/plugins/AtsumaruSharedSaveExperimental.js