search

yktsr / Text2Frame-MV

テキストファイル(.txtファイルなど)から「文章の表示」イベントコマンドに簡単に変換するための、RPGツクールMV・MZ用の開発支援プラグインです。/ Plugin for RPG Maker MV/MZ to convert text to event command
MIT License
9 stars 1 forks source link

MZ版プラグインコマンドタグの実装 #73

Closed HidetoshiKawaguchi closed 1 year ago

HidetoshiKawaguchi commented 3 years ago

(32)-2 プラグインコマンド(ツクールMZ, 上級者向け)

プラグインコマンドのイベントコマンドは、以下の記法で指定します。

<PluginCommandMZ: プラグイン名, 内部関数名, コマンド名, 引数の名前[値][注釈(任意)],...>`

プラグイン名はプラグインファイルの名前です。○○.jsの○○を記入してください。 Text2Frame.jsの場合はText2Frameとなります。

内部関数名はプラグイン内で設定されている関数名を指定してください。 ただし、対応しているプラグイン本体であるJavascriptファイルかdataフォルダ内のJSONファイルから直接確認する必要がある可能性が高いです。 そのため、このタグはある程度プラグインを開発する能力がある方向けとなります。

コマンド名はプラグインコマンド設定ウィンドウで、呼び出すコマンドの名前を記述してください。

プラグインコマンドのパラメータは、コマンド名以降にカンマ区切りで引数の名前[値]として記述してください。 数に制限はありません。 例えば、引数の名前がFileFolder, 値がtextの場合はFileFolder[text]と記述してください。 引数の名前は、「プラグインコマンド」ウィンドウの、指定したい引数の「パラメータ」ウィンドウから確認できます。 薄い灰色文字で書かれた括弧書きされている文字が引数の名前です。 注釈は、ツクールMZ上での表示を正式なものにするために使います。 指定しない場合は、自動で補完します。実行上の違いはありませんが、ツクールMZ上から設定した場合の表記とは異なります。

PluginCommandMZはPCZ,プラグインコマンドMZでも代替できます。

例えば、Text2Frameのプラグインコマンドを例にすると以下のように記述します。 textフォルダのmessage.txtの内容をマップID1, イベントID2, ページID3に上書きせずに書き込むプラグインコマンドです。

<PluginCommandMZ: Text2Frame, IMPORT_MESSAGE_TO_EVENT, イベントにインポート, FileFolder[text], FileName[message.txt], MapID[1], EventID[2], PageID[3], IsOverwrite[false]>