開発日誌

プラグイン/スクリプト

[ テクニック ] [ プラグイン/スクリプト ] 名前欄に応じて顔グラを自動表示

2021-07-21 01:02:42

RPGツクールMZで登場した「文章の表示」の名前欄に、\N[1]のように制御文字でアクター名を入れると、そのアクターの顔グラが自動的に表示されるというプラグインです。

以前、公式フォーラムで要望を受けて作成したものですが、いろいろ応用力が高そうだったので改めて紹介します。

※ 2021-07-24追記:
選択肢の表示や数値入力の処理が重複して実行される不具合を修正しました。お手数ですが、Version 1.1.2にアップデートをお願いします。

このプラグインを導入すると、「文章の表示」で名前欄を\N[x]と設定した際に、x番のアクターの顔グラフィックが自動的に設定されるようになります。

xのところは変数を用いて、\N[\V[y]]のように記述することも可能です。この場合、y番の変数に格納されている番号のアクターとなります。

既に顔グラが設定されていたり、名前欄の形式が合わない場合は無視されます。

注意点としては、文章のプレビューでは顔グラが表示されない点と、テキストがメッセージウィンドウからはみ出さないようにする点です。

文章の入力欄にはメッセージウィンドウの横幅を示す目安のラインが引いてあります。このラインは顔グラなしの場合の横幅になっていますが、実際には顔グラありの場合の横幅にテキストを収めないといけません。このプラグインを使う際は、なるべく横幅ギリギリのメッセージは避けましょう。

単純にキャラクター名やキャラの顔グラの指定を横着したい場合にも使えますが、応用範囲はけっこう広そうです。

条件によってキャラクターの名前や顔グラを入れ替えたい場合は、指定用のアクターを用意しておいて、そのアクターの名前やグラフィックを変更してやれば、文章の表示で自動的に反映されます。

メッセージ自体は共通のものにしたいが、対象のキャラによって名前や顔グラを変更したい場合は、対象となるキャラを示す変数を1つ用意して、その変数にアクター番号を代入します。あとはコモンイベントで、名前欄を\N[\V[x]]としたメッセージを表示してやれば、求める動作となります。

他にも応用できるシチュエーションはありそうです。顔グラを自動的に設定したいケースでは割と使えると思いますので、ぜひ利用をご検討ください。

なお、「文章の表示」の名前欄を使用する仕組みのため、RPGツクールMVでは利用できません。まあ、MVでは顔グラを変数等で設定できるプラグインが既にあったかと思いますが。

質問やアドバイスなどはコメント欄まで、お気軽にお願いします。素材利用条件などについては、このサイトについての「提供素材について」の項目などをご覧ください。

[ テクニック ] [ プラグイン/スクリプト ] サブフォルダ付きプラグインの仕様変更

2021-07-05 23:17:06

RPGツクールMZのバージョン1.3.2がリリースされました。

先々週公開のバージョン1.3.0で仕様追加されたサブフォルダ関連の改善がなされましたが、サブフォルダ内にjsファイルが格納されても正しくプラグインが動作するような修正対応「サブフォルダ内のプラグイン名取得」が、これによって逆に動作しなくなってしまいました。なんちゅうことしてくれた……。

当サイトのプラグインも再修正しました

というわけで、拙作プラグインも先日修正したものを再び修正しました。河原で積んだ石を鬼(公式)に壊された気分w

サブフォルダを使っていなければ特に影響はありませんが、6月23日以降にダウンロードされた方は、お手数ですが修正版を再度ダウンロードお願いします。

プラグイン名の自動取得

ただ元に戻すのは癪だったので、この機会にプラグイン名を自動的に取得できるようにしてみました。

具体的には、

const pluginName = decodeURIComponent(document.currentScript.src).match(/([^\/]+)\.js$/)[1];

として、自分のファイルパスからファイル名を取得しています。

従来はプラグインのファイル名を変更すると動作しなくなっていたのですが、これによりファイル名を変更しても動作するようになります。

ただ、プラグインファイル名については、ユーザーで勝手に変更することを想定していないケースが多く、特にMZ以降、@base@orderAfterなどのプラグインの依存関係を定義するアノテーションも登場したため、ある程度の知識がないとファイル名の変更は推奨されません。

1.3.2修正の要点

結局のところプラグインのサブフォルダ問題は、

  • プラグインパラメータやプラグインコマンドはサブフォルダ名を含まない、プラグインファイル名のみをキーにして取得
  • 同名のプラグインが別フォルダに存在する場合は重複している旨の警告が出る

という形で対応がなされたようです。

つまり、プラグイン名は別フォルダであっても同名のファイルを避けるようにするべきで、サブフォルダは純粋に、ユーザーが多数のプラグインファイルを分類して整理できるようにした便利機能と位置づけられた模様です。

既に1.3.0の時点で対応修正した分が無駄にならないように、とか、プラグインIDとファイルパスを別々に指定できるように、とかの提案もあったようですが、結局1.3.0対応の修正は思いっきり無視されて、最小限の修正で済むような対応となった模様です。

まあ、一時のマズい仕様に対応するために余計なコードを増やしてもしょうがないので、これはこれで仕方ないかと。明らかに影響範囲の広すぎる仕様変更だったので、性急に個人で対応せず、公式の発表を待てばよかったかもしれませんね。我々が騒いだから、公式も影響の大きさに気付いた、という面もありそうですが……。

お陰でコアスクリプトの理解も進んだし、.match( )に入れた部分を簡単に取得する方法も今回の修正を通じて知れたので、収穫もあった……とポジティブ思考。

[ テクニック ] [ プラグイン/スクリプト ] サブフォルダ内のプラグイン名取得

2021-06-22 23:14:17

※追記:
バージョン1.3.2の修正で、本対応は不要となりました。逆に動作しない原因となるため、お手数ですが各プラグインの再ダウンロードをお願いします。
サブフォルダ付きプラグインの仕様変更」記事参照。

RPGツクールMZのバージョン1.3.0(1.3.1)がリリースされ、プラグインフォルダにサブフォルダを作れるようになりました。

多くのプラグインは、プラグインパラメータやプラグインコマンドの取得のため、自分のプラグイン名を指定する必要がありますが、jsファイルをサブフォルダ内に入れることは基本的に想定されていないため、このままだと動作しなくなってしまいます。

ここではプラグイン作者向けに、サブフォルダ内に格納された場合でも、自分のプラグイン名を正しく取得するスクリプトを紹介します。

サブフォルダでプラグイン整理

RPGツクールでプラグインとして提供されるjsファイルは、プロジェクトフォルダの中にある js/pluins フォルダの中に格納する決まりになっています。

しかし、プラグインは何十個と導入するケースも珍しくなく、pluginsフォルダの中に大量のファイルが存在することになってしまいます。

このことから、RPGツクールMZバージョン1.3.0では、pluginsフォルダの中にサブフォルダを作ることができるようになりました。これによって、プラグイン作者別に整理したり、戦闘系・マップ系・メニュー系・立ち絵系……などとジャンル別に整理したり、といったことが可能になりました。

非常に便利ですね!

▲フォルダ内に雑然とあったファイルが…

▲この通りフォルダ分けされてスッキリ!

プラグイン作者泣かせの変更

しかし、この変更はプラグイン作者にとってはかなり厄介です。

プラグインパラメータやプラグインコマンドの実装の際、自分のプラグイン名を指定する必要があります。サブフォルダ内に格納されたプラグインの場合は、このプラグイン名が「サブフォルダ名/プラグイン名」となります。

もともとサブフォルダ内に格納できる仕様ではなかったため、多くのプラグインでは冒頭で、

const pluginName = 'プラグイン名';

のように自プラグイン名を直接指定しており、「プラグインのファイル名は変えないでください」で通していました。しかし、サブフォルダ名はユーザーの任意で付けられるので、プラグイン作者の方で事前に指定することができません。

document.currentScript.scrで自ファイル名を自動的に取得する方法もありますが、現在普及している書き方はやはり、サブフォルダ内に格納されることを想定していないため、正常に動作しません。

また、サブフォルダの中にさらにサブフォルダを作ることも可能となっており、全てのパターンに対応しようとすると、けっこう一筋縄ではいきません。

自分のプラグイン名を取得する

というわけで、自分のプラグイン名を取得するのにどう書けばいいのかということですが、トリアコンタンさんが真っ先に取得方法を上げてくださっていました。ありがとうございます。

https://gist.github.com/triacontane/71064daf535160d4d355aeb9bc3c49f9

以下は、それを参考に少しアレンジしたコードです。ご自由にお使いください。

const pluginName = decodeURIComponent(document.currentScript.src).replace(/^.*?\/plugins\/(.*).js$/, "$1");

※追記:
さらに、うなぎおおとろさんが改良版を上げていらっしゃったので、それを採用しました。ありがとうございます。

https://github.com/unagiootoro/RPGMZ

const pluginName = decodeURIComponent(document.currentScript.src).match(/^.*\/js\/plugins\/(.+)\.js$/)[1];

少し詳しく解説すると、decodeURIComponentは、フォルダ名やファイル名が日本語(非ASCII文字)の場合に、正しく日本語に変換(デコード処理)するための関数です。

document.currentScript.srcで自分のjsファイル名を取得できますが、これで取得できるのはフルURIのため、ここからプラグイン名のみを抽出する必要があります。

抽出は正規表現を使って、/js/plugins/から末尾の.jsまでの間の文字をプラグイン名として取得しています。

※さらに追記:
当初、正規表現の冒頭を^.*?として最短マッチを使うことで、サブフォルダ名に「plugins」が使われても正しくマッチさせるようにしていましたが、逆に配信サイトのURLに万一「plugins」が入っていた場合に動かなくなるとの指摘をいただいたため、修正しました。そんなことする人もいないと思いますが、サブフォルダをjs/pluginsにはしないようにしてください。

他に、もっとスマートな書き方とか、この書き方だと正常に動作しないケースとかがあれば、教えてください。

当サイトのプラグインも修正しました

というわけで、プラグインパラメータもプラグインコマンドも使っていないプラグイン以外は、現在出回っているほとんどのプラグインに影響が出ると思います。厄介なことしてくれちゃって……。

まあ、フォルダ分けしなければ影響は出ないので、使えなくなるというわけでもありませんし、修正はごくわずかです。ユーザーの方でも難しい修正では全然ありません。

拙作プラグインもほとんど影響が出るので、全て修正しました。めんどくさかった……。

[ テクニック ] [ 素材 ] [ プラグイン/スクリプト ] イベントキャラ移動の改善プラグイン

2021-06-17 23:08:30

イベントキャラクターのランダム移動やプレイヤーに近づく移動を改善するプラグインを作りました。RPGツクールMVとRPGツクールMZの両方に対応しています。

イベントキャラクターの移動に関して以下の3点を改善します。

1点目は「移動ルートの設定」における「ランダムに移動」。

RPGツクールの標準のランダム移動は、まず上下左右4方向からランダムに移動方向を決定し、その方向に移動ができたら移動する、という仕組みになっています。ランダムに決定された方向に障害物があって動けない時は、移動が発生しません。

したがって、3方向を囲まれた袋小路のような場所にキャラクターがいる場合、1/4の確率でしか動かないことになります。

このプラグインはそれを改善します。先に上下左右4方向で移動可能な方向をリストアップし、その移動可能な方向の中からランダムに移動方向を決定します。したがって、袋小路のような場所でも必ず動ける方向に動きます。

2点目は「自律移動」の「ランダム」。

RPGツクールにおける自律移動タイプの「ランダム」は、実は完全にランダムに移動するわけではなく、1/2の確率で今向いている方向にそのまま前進、1/6の確率でその場に停止、1/3の確率でランダムな方向に移動する仕組みになっています。

完全にランダムだと周りをウロウロするだけの怪しい動きになってしまうので、これ自体は動きを自然に見せるための仕組みだと評価できます。ただ、それぞれの確率を調整したい場合もあるでしょう。

このプラグインは、プラグインパラメータで前進と停止の確率を調整できます。デフォルトは前進が50%(1/2)、停止が17%(1/6)となっており、この値を変更すれば、ランダム移動の確率を高くしたりすることができます。

また、1点目のランダム移動の改善も適用されるため、キャラクターがランダム移動で狭い場所に入り込んでしまった時の動きが、劇的に改善されると思います。

そして3点目は「自律移動」の「近づく」。

RPGツクールにおける自律移動タイプの「近づく」は、ランダムと同様、常にプレイヤーに近づいてくるわけではなく、少し遊びのある動きをします。具体的には、プレイヤーに近づいてくる移動は2/3の確率であり、1/6の確率でランダムに移動、1/6の確率で今向いている方向にそのまま前進します。

敵が追いかけてくるような動きの場合は、この確率だと少々無駄な動きが多く、かといってカスタム移動の「プレイヤーに近づく」だと100%近づいてきてしまうため、それはそれで逃げ場がありません。

ランダム移動と同様、プラグインパラメータでランダム移動と前進の確率を調整できます。デフォルトはどちらも17%(1/6)で、この値を小さくすれば、より積極的に近づいてくる動きになります。

実際の動きはこんな感じ。狭い場所に入った時のランダムな動きや、プレイヤーへの接近具合が改善されているのが分かります。

質問やアドバイスなどはコメント欄まで、お気軽にお願いします。素材利用条件などについては、このサイトについての「提供素材について」の項目などをご覧ください。

[ テクニック ] [ プラグイン/スクリプト ] 戦闘中にアイテムコマンドで武器変更

2021-06-05 22:22:57

戦闘コマンドの「アイテム」で、アイテムの使用だけでなく武器の装備変更もできるプラグインを作りました。RPGツクールMVとRPGツクールMZの両方に対応しています。

戦闘中に装備が変更できるプラグインは既にありますが、独自のコマンドではなく既存の「アイテム」コマンドにその機能を追加したところがポイントで、戦闘コマンドの数が増えないのでレイアウトに影響を及ぼしません。

代わりに、武器以外の装備を変更したり、変更前後の攻撃力を確認できる機能などは持たせていません。実際、戦闘中に武器を持ち替えるのは問題なくできそうですが、鎧を一度脱いで別の鎧に着替えてたりしたら、その間に一方的に攻撃を受けてしまいそうですw

あと、二刀流の場合の考慮も適当で、一方の武器しか変更できません。というか、両手の武器を変更するのにうまいインターフェースがあれば教えてください。

デフォルトでは、武器を変更したら、その新しい武器で通常攻撃をするようになっており、直ちに敵ターゲットの選択に移ります(全体攻撃武器の場合は次のアクターのコマンド選択に移ります)。もちろんターゲット選択をキャンセルすれば、別の行動を選択することもできます。武器の変更にはターンを消費しないので、何度でも武器の変更は可能です。

この挙動はプラグインパラメータで変更も可能で、「武器変更後通常攻撃」をOFFにすると、武器変更後は戦闘コマンドの選択に戻ります。

質問やアドバイスなどはコメント欄まで、お気軽にお願いします。素材利用条件などについては、このサイトについての「提供素材について」の項目などをご覧ください。