//============================================================================= // AtsumaruSharedSave.js // // Copyright (c) 2018-2021 ゲームアツマール開発チーム(https://game.nicovideo.jp/atsumaru) // Released under the MIT license // http://opensource.org/licenses/mit-license.php //============================================================================= (function () { 'use strict'; function isNumber(value) { return value !== "" && !isNaN(value); } function isInteger(value) { return typeof value === "number" && isFinite(value) && Math.floor(value) === value; } function isNatural(value) { return isInteger(value) && value > 0; } function isValidVariableId(variableId) { return isNatural(variableId) && variableId < $dataSystem.variables.length; } /*! ***************************************************************************** Copyright (c) Microsoft Corporation. Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ***************************************************************************** */ function __spreadArray(to, from) { for (var i = 0, il = from.length, j = to.length; i < il; i++, j++) to[j] = from[i]; return to; } // 既存のクラスとメソッド名を取り、そのメソッドに処理を追加する function hook(baseClass, target, f) { baseClass.prototype[target] = f(baseClass.prototype[target]); } function hookStatic(baseClass, target, f) { baseClass[target] = f(baseClass[target]); } // プラグインコマンドを追加する function addPluginCommand(commands) { hook(Game_Interpreter, "pluginCommand", function (origin) { return function (command, args) { origin.apply(this, arguments); if (commands[command]) { commands[command].apply(this, __spreadArray([command], args)); } }; }); } // Promiseが終了するまでイベントコマンドをウェイトするための処理を追加する function prepareBindPromise() { if (!!Game_Interpreter.prototype.bindPromiseForRPGAtsumaruPlugin) { return; } // Promiseを実行しつつ、それをツクールのインタプリタと結びつけて解決されるまで進行を止める Game_Interpreter.prototype.bindPromiseForRPGAtsumaruPlugin = function (promise, resolve, reject) { var _this = this; this._index--; this._promiseResolverForRPGAtsumaruPlugin = function () { return false; }; promise.then(function (value) { return _this._promiseResolverForRPGAtsumaruPlugin = function () { _this._index++; delete _this._promiseResolverForRPGAtsumaruPlugin; if (resolve) { resolve(value); } return true; }; }, function (error) { return _this._promiseResolverForRPGAtsumaruPlugin = function () { for (var key in _this._eventInfo) { error[key] = _this._eventInfo[key]; } error.line = _this._index + 1; error.eventCommand = "plugin_command"; error.content = _this._params[0]; switch (error.code) { case "BAD_REQUEST": throw error; case "UNAUTHORIZED": case "FORBIDDEN": case "INTERNAL_SERVER_ERROR": case "API_CALL_LIMIT_EXCEEDED": default: console.error(error.code + ": " + error.message); console.error(error.stack); if (Graphics._showErrorDetail && Graphics._formatEventInfo && Graphics._formatEventCommandInfo) { var eventInfo = Graphics._formatEventInfo(error); var eventCommandInfo = Graphics._formatEventCommandInfo(error); console.error(eventCommandInfo ? eventInfo + ", " + eventCommandInfo : eventInfo); } _this._index++; delete _this._promiseResolverForRPGAtsumaruPlugin; if (reject) { reject(error); } return true; } }; }); }; // 通信待機中はこのコマンドで足踏みし、通信に成功または失敗した時にPromiseの続きを解決する // このタイミングまで遅延することで、以下のようなメリットが生まれる // 1.解決が次のコマンドの直前なので、他の並列処理に結果を上書きされない // 2.ゲームループ内でエラーが発生するので、エラー発生箇所とスタックトレースが自然に詳細化される // 3.ソフトリセット後、リセット前のexecuteCommandは叩かれなくなるので、 // リセット前のPromiseのresolverがリセット後のグローバルオブジェクトを荒らす事故がなくなる hook(Game_Interpreter, "executeCommand", function (origin) { return function () { if (this._promiseResolverForRPGAtsumaruPlugin) { var resolved = this._promiseResolverForRPGAtsumaruPlugin(); if (!resolved) { return false; } } return origin.apply(this, arguments); }; }); } function toDefined(value, command, name) { if (value === undefined) { throw new Error("「" + command + "」コマンドでは、" + name + "を指定してください。"); } else { return value; } } function toNatural(value, command, name) { value = toDefined(value, command, name); var number = +value; if (isNumber(value) && isNatural(number)) { return number; } else { throw new Error("「" + command + "」コマンドでは、" + name + "には自然数を指定してください。" + name + ": " + value); } } function toValidVariableId(value, command, name) { value = toDefined(value, command, name); var number = +value; if (isNumber(value) && isValidVariableId(number)) { return number; } else { throw new Error("「" + command + "」コマンドでは、" + name + "には1~" + ($dataSystem.variables.length - 1) + "までの整数を指定してください。" + name + ": " + value); } } function toTypedParameters(parameters, isArray) { if (isArray === void 0) { isArray = false; } var result = isArray ? [] : {}; for (var key in parameters) { try { var value = JSON.parse(parameters[key]); result[key] = value instanceof Array ? toTypedParameters(value, true) : value instanceof Object ? toTypedParameters(value) : value; } catch (error) { result[key] = parameters[key]; } } return result; } function ensureValidVariableIds(parameters) { hookStatic(DataManager, "isDatabaseLoaded", function (origin) { return function () { if (!origin.apply(this, arguments)) { return false; } for (var key in parameters) { var variableId = parameters[key]; if (variableId !== 0 && !isValidVariableId(variableId)) { throw new Error("プラグインパラメータ「" + key + "」には、0~" + ($dataSystem.variables.length - 1) + "までの整数を指定してください。" + key + ": " + variableId); } } return true; }; }); } /*: * @plugindesc RPGアツマールの共有セーブのためのプラグインです * @author RPGアツマール開発チーム * * @param startVariableId * @type variable * @text 共有セーブの保存範囲(開始) * @desc 「共有セーブ保存」コマンドで保存する変数の番号を指定します。 * @default 0 * * @param finishVariableId * @type variable * @text 共有セーブの保存範囲(終了) * @desc 「共有セーブ保存」コマンドで保存する変数の番号を指定します。 * @default 0 * * @param errorMessage * @type variable * @text エラーメッセージ * @desc エラーが発生した場合に、エラーメッセージを代入する変数の番号を指定します。 * @default 0 * * @help * このプラグインは、アツマールAPIの「共有セーブ」を利用するためのプラグインです。 * 詳しくはアツマールAPIリファレンス(https://atsumaru.github.io/api-references/shared-save)を参照してください。 * * プラグインコマンド(英語版と日本語版のコマンドがありますが、どちらも同じ動作です): * SetSharedSave * 共有セーブ保存 * # 共有セーブの保存範囲(開始-終了)で指定した範囲の変数を読み込み、 * 自分の共有セーブとして保存します。 * # 例: SetSharedSave * # : 共有セーブ保存 * * GetSharedSave * 共有セーブ取得 * # 変数からユーザーIDを読み取り、 * そのユーザーの共有セーブをを先頭にして代入します。 * # 例: GetSharedSave 1 201 * # : 共有セーブ取得 1 201 * (共有セーブの保存範囲が101-150で計50個の場合、変数1番に格納されたユーザーIDの人の共有セーブを201-250に代入) * * アツマール外(テストプレイや他のサイト、ダウンロード版)での挙動: * SetSharedSave(共有セーブ保存) * 無視される(エラーメッセージにも何も代入されない) * GetSharedSave(共有セーブ取得) * 無視される(エラーメッセージにも何も代入されない) * * 備考: * ・本プラグインは、共有セーブの保存領域をすべて使用します。 * そのため、共有セーブを活用する他のプラグインと共存することはできません。 * ・ゲームを公開後に共有セーブの保存範囲を変更する時は、 * 古い保存範囲のセーブデータとの互換性にご注意ください。 * * ※「並列処理」の中でプラグインコマンドを利用しますと * その時セーブしたセーブデータの状態が不確定になりますので、 * 可能な限り「並列処理」以外のトリガーでご利用ください。 */ var parameters = toTypedParameters(PluginManager.parameters("AtsumaruSharedSave")); var setItems = window.RPGAtsumaru && window.RPGAtsumaru.storage.setItems; var getSharedItems = window.RPGAtsumaru && window.RPGAtsumaru.storage.getSharedItems; ensureValidVariableIds(parameters); prepareBindPromise(); addPluginCommand({ SetSharedSave: SetSharedSave, "共有セーブ保存": SetSharedSave, GetSharedSave: GetSharedSave, "共有セーブ取得": GetSharedSave }); function SetSharedSave() { var variables = []; for (var i = parameters.startVariableId; i <= parameters.finishVariableId; i++) { variables.push($gameVariables.value(i)); } var value = JSON.stringify(variables); if (setItems) { this.bindPromiseForRPGAtsumaruPlugin(setItems([{ key: "Atsumaru Shared", value: value }]), function () { return $gameVariables.setValue(parameters.errorMessage, 0); }, function (error) { return $gameVariables.setValue(parameters.errorMessage, error.message); }); } } function GetSharedSave(command, userIdVariableIdStr, startVariableIdStr) { var userIdVariableId = toValidVariableId(userIdVariableIdStr, command, "userIdVariableId"); var userId = toNatural($gameVariables.value(userIdVariableId), command, "userId"); var startVariableId = toValidVariableId(startVariableIdStr, command, "startVariableId"); if (getSharedItems) { this.bindPromiseForRPGAtsumaruPlugin(getSharedItems([userId]), function (sharedSaves) { if (sharedSaves[userId]) { var variables = JSON.parse(sharedSaves[userId]); for (var i = 0; i < variables.length; i++) { $gameVariables.setValue(i + startVariableId, variables[i]); } $gameVariables.setValue(parameters.errorMessage, 0); } else { $gameVariables.setValue(parameters.errorMessage, "指定したユーザーの共有セーブは見つかりませんでした"); } }, function (error) { return $gameVariables.setValue(parameters.errorMessage, error.message); }); } } }());