Torigoya 通知メッセージアドオン:アツマールグローバルシグナル通知ログ - TorigoyaMZ_NotifyMessage_AddonAtsumaruGlobalSignal.js

シェア用テキスト：

▼Torigoya 通知メッセージアドオン:アツマールグローバルシグナル通知ログ（Ruたん様作） - TorigoyaMZ_NotifyMessage_AddonAtsumaruGlobalSignal.js
https://plugin-mz.fungamemake.com/archives/6780
ゲームアツマールのグローバルシグナルAPIを利用して全ユーザーで共有のイベントログを表示する機能を追加します。

ふりがな：つうちめっせーじあどおん:あつまーるぐろーばるしぐなるつうちろぐ

機能概要： ゲームアツマールのグローバルシグナルAPIを利用して全ユーザーで共有のイベントログを表示する機能を追加します。

利用規約（ライセンス）：
パブリックドメイン
・著作権：放棄

作者：Ruたん

作者サイト：https://torigoya-plugin.rutan.dev/

解説ページ：https://torigoya-plugin.rutan.dev/service/notifyMessage…

ファイル名：TorigoyaMZ_NotifyMessage_AddonAtsumaruGlobalSignal.js

プラグインのヘルプ：

/*:
 * @target MZ
 * @plugindesc 通知メッセージアドオン: アツマールグローバルシグナル通知ログ (v.1.0.2)
 * @author Ruたん（ru_shalm）
 * @license public domain
 * @version 1.0.2
 * @url https://raw.githubusercontent.com/rutan/torigoya-rpg-maker-plugin/gh-pages/TorigoyaMZ_NotifyMessage_AddonAtsumaruGlobalSignal.js
 * @base TorigoyaMZ_NotifyMessage
 * @orderAfter TorigoyaMZ_NotifyMessage
 * @help
 * 通知メッセージアドオン: アツマールグローバルシグナル通知ログ (v.1.0.2)
 * https://torigoya-plugin.rutan.dev
 *
 * ※このプラグインはゲームアツマール用の非公式プラグインです
 *
 * ゲームアツマールのグローバルシグナルAPIを利用して
 * 全ユーザーで共有のイベントログを表示する機能を追加します。
 *
 * ------------------------------------------------------------
 * ■ 注意事項
 * ------------------------------------------------------------
 * ・非公式のプラグインです。突然動かなくなる場合があります。
 *
 * ・イベントログのデータサイズが大きい場合、
 * 　APIのサイズ上限に引っかかり正常に送信できない場合があります
 *
 * ・他のプラグインからグローバルシグナルAPIを使用している場合
 * 　競合する可能性があります。ご注意ください。
 *
 * ------------------------------------------------------------
 * ■ 使用方法：イベントログの設定
 * ------------------------------------------------------------
 * 事前に表示するイベントログの種類を登録する必要があります。
 *
 * 「イベントログ種別」に以下の情報を設定してください。
 *
 * ・種別キー
 * イベントログの種類を表す言葉です。
 * ここで設定した言葉をイベントコマンドで使用します。
 * データサイズが小さい、短い英語がおすすめ！
 *
 * ・ログ文章
 * イベントログの文章として表示するテンプレートを設定します。
 * ここで設定した文章が通知として表示されます。
 * ここには一部特殊な記法を利用することができます（後述）
 *
 * ・アイコンID
 * 通知に表示するアイコンを設定します
 *
 * ------------------------------------------------------------
 * ■ 使用方法：通知の発行
 * ------------------------------------------------------------
 * 通知を発行したいタイミングで
 * プラグインコマンドの「イベントログの送信」を実行してください。
 *
 * 種別キーには「イベントログ種別」で設定したものを指定してください。
 *
 * ------------------------------------------------------------
 * ■ ログ文章の記法について
 * ------------------------------------------------------------
 * ログ文章には文章の表示と同様の記法を利用できます。
 *
 * ＜通知を送った人の名前について＞
 * 文章中に SIG_NAME と記述することで、
 * その通知を送った人のアツマール上での名前が表示されます。
 *
 * 使用例） SIG_NAME さんがログインしました
 *
 * ＜変数などの表示について＞
 * V[xx] などの変数表示は自分自身のものが表示されます。
 * そのため、他のプレイヤーが送ったイベント通知であっても、
 * 他のプレイヤーの変数ではなく自分の変数が表示されてしまいます。
 *
 * もし、他のプレイヤーの変数の中身が表示されてほしい場合は、
 * V[xx] ではなく SIG_V[xx] と指定してください。
 *
 * 使用例） SIG_NAME が SIG_V[1] ゴールド獲得！
 *
 * @param base
 * @text ■ 基本設定
 *
 * @param baseEventLogs
 * @text イベントログ種別
 * @desc イベントログの種類を定義します。
 * @type struct<EventLog>[]
 * @parent base
 * @default []
 *
 * @param baseFirstFetchLimit
 * @text 起動時に過去ログを最大何件取得するか？
 * @desc 起動時に最大何件のログを取得するか指定します。
 * @type number
 * @parent base
 * @min 0
 * @default 5
 *
 * @param advanced
 * @text ■ 上級設定
 *
 * @param advancedForceMute
 * @text 効果音を強制無効化
 * @desc 通知の効果音を強制的に無効化するか選択できます。
 * うるさいので無効化がオススメ。
 * @type boolean
 * @parent advanced
 * @on 強制無効化する
 * @off 無効化しない
 * @default true
 *
 * @param advancedFetchInterval
 * @text グローバルシグナルの取得間隔(秒)
 * @desc グローバルシグナルを何秒おきに取得するか設定します。
 * 短くしすぎるとAPI上限に引っかかるため注意。
 * @type number
 * @parent advanced
 * @min 10
 * @default 60
 *
 * @command sendEvent
 * @text イベントログの送信
 * @desc 指定のイベントログを送信します
 *
 * @arg key
 * @text 種別キー
 * @desc 送信するイベント種別の識別名です。
 * プラグイン設定で指定したものを指定してください。
 * @type string
 *
 * @arg iconVariable
 * @text アイコンID（変数指定）
 * @desc 通知に表示するアイコンIDが設定された変数を指定します。
 * 「なし」の場合はデフォルトのアイコンを使用します。
 * @type variable
 * @default 0
 */