他のユーザーと小さなデータ(信号)をやり取りするためのAPIプラグイン – AtsumaruUserSignalExperimental.js

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

プラグインコマンド(英語版と日本語版のコマンドがありますが、どちらも同じ動作です):
SendUserSignal <signalDataVariableId> <userIdVariableId>
ユーザーシグナル送信 <signalDataVariableId> <userIdVariableId>
# 変数<signalDataVariableId>からシグナルデータを読み取り、
それを変数<userIdVariableId>から読み取ったユーザーIDの相手に送信します。
# 例: SendUserSignal 1 2
# : ユーザーシグナル送信 1 2

GetUserSignal
ユーザーシグナル取得
# まだ取得したことがないユーザーシグナルの中で最も古い一件を読み込み、
プラグインパラメータで指定した変数に値をセットします。
# 残シグナル数が0だった時は、シグナルデータと送信者のユーザーID/名前には0がセットされます。
# 残シグナル数が0か1だった時は、次の取得コマンドで新たなシグナルの受信を試みますので
時間がかかることがあります。スムーズに実行したい場合は、
次の取得コマンドの実行(受信)までに10秒以上の時間を空けてください。
# 例: GetUserSignal
# : ユーザーシグナル取得

アツマール外(テストプレイや他のサイト、ダウンロード版)での挙動:
SendUserSignal(ユーザーシグナル送信)
無視される(エラーメッセージにも何も代入されない)
GetUserSignal(ユーザーシグナル取得)
無視される(エラーメッセージにも何も代入されない)

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

param senderId
type variable
text 送信者のユーザーID
desc ユーザーシグナルの取得時に、送信者のユーザーIDを代入する変数の番号を指定します。
default 0

param senderName
type variable
text 送信者のユーザー名
desc ユーザーシグナルの取得時に、送信者のユーザー名を代入する変数の番号を指定します。
default 0

param restCount
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/AtsumaruUserSignalExperimental.js