アツマールAPIの「グローバルサーバー変数」を利用するためのプラグイン – AtsumaruGlobalServerVariableExperimental.js

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

プラグインコマンド(英語版と日本語版のコマンドがありますが、どちらも同じ動作です):
TriggerCall <triggerId>
トリガー発動 <triggerId>
# 指定した<triggerId>の「固定値を増減」トリガーを発動させる
# 例: TriggerCall 1
# : トリガー発動 1

TriggerCall <triggerId> <valueVariableId>
トリガー発動 <triggerId> <valueVariableId>
# 変数<valueVariableId>から値を読み取り、指定した<triggerId>の「最大値・最小値の範囲で増減」トリガー、または「値を代入」型トリガーを発動させる
# 例: TriggerCall 1 5
# : トリガー発動 1 5

TriggerCallByName <globalServerVariableName> <triggerName>
名前でトリガー発動 <globalServerVariableName> <triggerName>
# 指定した<globalServerVariableName> <triggerName>の「固定値を増減」トリガーを発動させる
# 例: TriggerCallByName 変数1 トリガー名1
# : 名前でトリガー発動 変数1 トリガー名1

TriggerCallByName <globalServerVariableName> <triggerName> <valueVariableId>
名前でトリガー発動 <globalServerVariableName> <triggerName> <valueVariableId>
# 変数<valueVariableId>から値を読み取り、指定した<globalServerVariableName> <triggerName>の「最大値・最小値の範囲で増減」トリガー、または「値を代入」型トリガーを発動させる
# 例: TriggerCallByName 変数1 トリガー名1 5
# : 名前でトリガー発動 変数1 トリガー名1 5

GetGlobalServerVariable <globalServerVariableId>
グローバルサーバー変数取得 <globalServerVariableId>
# グローバルサーバー変数<globalServerVariableId>の情報(現在値・最小値・最大値・変数名)を読み込み、
プラグインパラメータで指定した変数に値をセットする。
# 例: GetGlobalServerVariable 1
# : グローバルサーバー変数取得 1

GetGlobalServerVariableByName <globalServerVariableName>
名前でグローバルサーバー変数取得 <globalServerVariableName>
# グローバルサーバー変数<globalServerVariableName>の情報(現在値・最小値・最大値・変数名)を読み込み、
プラグインパラメータで指定した変数に値をセットする。
# 例: GetGlobalServerVariableByName 変数1
# : 名前でグローバルサーバー変数取得 変数1

アツマール外(テストプレイや他のサイト、ダウンロード版)での挙動:
TriggerCall(トリガー発動)
無視される(エラーメッセージにも何も代入されない)
GetGlobalServerVariable(グローバルサーバー変数取得)
無視される(エラーメッセージにも何も代入されない)

※「並列処理」の中でプラグインコマンドを利用しますと
その時セーブしたセーブデータの状態が不確定になりますので、
可能な限り「並列処理」以外のトリガーでご利用ください。
パラメータ
param value
type variable
text 現在値
desc グローバルサーバー変数の取得時に、現在値を代入する変数の番号を指定します。
default 0

param minValue
type variable
text 最小値
desc グローバルサーバー変数の取得時に、最小値を代入する変数の番号を指定します。
default 0

param maxValue
type variable
text 最大値
desc グローバルサーバー変数の取得時に、最大値を代入する変数の番号を指定します。
default 0

param name
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/AtsumaruGlobalServerVariableExperimental.js