FTKR Menu Event - FTKR_MenuEvent.js

シェア用テキスト:
▼FTKR Menu Event(フトコロ様作) - FTKR_MenuEvent.js
https://plugin.fungamemake.com/archives/1381
メニュー画面上でコモンイベントを実行する

ふりがな:めにゅーちゅうこもんいべんと

機能概要: メニュー画面上でコモンイベントを実行する

利用規約(ライセンス): MITライセンス

作者:フトコロ

作者サイト:https://twitter.com/futokoro_mv

ダウンロードページ:https://raw.githubusercontent.com/futokoro/RPGMaker/mas…

ファイル名:FTKR_MenuEvent.js

プラグインのヘルプ:

/*:
 * @plugindesc v1.1.0 メニュー画面上でコモンイベントを実行できるようにする
 * @author フトコロ
 *
 * @param Enable Item Event
 * @desc アイテムイベントのメニュー表示中の動作を設定します。
 * @type boolean
 * @on メニューで実行
 * @off マップで実行
 * @default false
 *
 * @param Enable Item SubCom Event
 * @desc アイテムのサブコマンドで実行するコモンイベントのメニュー表示中の動作を設定します。
 * @type boolean
 * @on メニューで実行
 * @off マップで実行
 * @default false
 *
 * @param Enable Skill Event
 * @desc スキルイベントのメニュー表示中の動作を設定します。
 * @type boolean
 * @on メニューで実行
 * @off マップで実行
 * @default false
 *
 * @param Display Priority
 * @desc メッセージウィンドウとピクチャのどちらを前面に表示するか設定します。
 * @type boolean
 * @on メッセージウィンドウ
 * @off ピクチャ
 * @default false
 *
 * @param Auto Refresh Item Window
 * @desc コモンイベント実行時にアイテムウィンドウを自動更新するか設定します。
 * @type boolean
 * @on 自動更新ON
 * @off 自動更新OFF
 * @default false
 *
 * @param Enabled Message Window Setting
 * @desc メニュー画面で表示するメッセージウィンドウの設定を有効にします。
 * @type boolean
 * @on 有効
 * @off 無効
 * @default false
 *
 * @param Menu Message Window
 * @desc メニュー画面で表示するメッセージウィンドウを設定します。
 * ※メッセージウィンドウ前面設定の時のみ有効
 * @type struct<menu>
 * @default {”Window_Skin”:”Window”,”Font_Size”:”28”,”Window_Padding”:”18”,”Window_Line_Height”:”36”,”Window_Opacity”:”192”,”Hide_Window_Frame”:”false”}
 * 
 * @help 
 *-----------------------------------------------------------------------------
 * 概要
 *-----------------------------------------------------------------------------
 * メニュー画面上でアイテムやスキルの特徴で設定したコモンイベントを
 * 実行できるようにします。
 * 
 * ただし、すべてのイベントコマンドが実行できるわけではありません。
 * 
 * 
 *-----------------------------------------------------------------------------
 * 設定方法
 *-----------------------------------------------------------------------------
 * 1.「プラグインマネージャー(プラグイン管理)」に、本プラグインを追加して
 *    ください。
 * 
 * 2. FTKR_ItemSubCommand.jsと組み合わせる場合は、本プラグインが
 *    下になるように配置してください。
 * 
 * 3. メッセージウィンドウに関するプラグインと組み合わせて使用する場合には
 *    プラグインパラメータ Enabled Message Window Setting を無効にして
 *    使ってください。
 * 
 * 
 *-----------------------------------------------------------------------------
 * コモンイベントの設定方法
 *-----------------------------------------------------------------------------
 * メニュー上でコモンイベントを実行するためには、
 * 必ずコモンイベントの最後に、以下のプラグインコマンドを追加してください。
 * 
 * 1. アクターを選択するアイテム・スキルの場合
 *      ME_アクター選択に戻る
 *      ME_ACTIVATE_ACTOR_WINDOW
 * 
 *    なお、コモンイベントの中で、選択中のアイテムの所持数が0になった場合は
 *    アクター選択ではなく、アイテム選択画面に自動的に戻ります。
 * 
 * 
 * 2. アクターを選択しないアイテム・スキルの場合
 *      ME_アイテム選択に戻る
 *      ME_ACTIVATE_ITEM_WINDOW
 * 
 *      または
 * 
 *      ME_スキル選択に戻る
 *      ME_ACTIVATE_SKILL_WINDOW
 * 
 * 
 * また、コモンイベントの中で、アイテムの所持数を増減させた場合には
 * アイテムウィンドウの更新が必要です。
 * 更新しないと画面上の数字に反映されません。
 * 
 * プラグインパラメータで一律で自動更新を設定できますが、以下のプラグイン
 * コマンドでも更新することができます。
 * 
 *      ME_アイテムウィンドウを更新する
 *      ME_REFRESH_ITEM_WINDOW
 * 
 * 
 *-----------------------------------------------------------------------------
 * サブコマンドプラグイン(FTKR_ItemSubCommand.js)と併用する場合
 *-----------------------------------------------------------------------------
 * サブコマンドプラグインと併用する場合に、サブコマンドで実行するコモンイベントも
 * メニュー画面上で実行可能です。
 * 
 * サブコマンドのイベントの場合は、以下のプラグインコマンドをイベントの最後に
 * 追加してください。
 * 
 *      ME_サブコマンド選択に戻る
 *      ME_ACTIVATE_SUB_WINDOW
 * 
 * ただし、サブコマンドイベント実行中に、選択中のアイテムの所持数が0になった場合は
 * サブコマンド選択画面ではなく、アイテム選択画面に自動的に戻ります。
 * 
 * 
 * 上記プラグインコマンドの変わりに以下の、プラグインコマンドを使うことも
 * 可能です。
 * 
 *      ME_アイテム選択に戻る
 *      ME_ACTIVATE_ITEM_WINDOW
 * 
 * この場合、イベント終了後にサブコマンドを閉じて、アイテム選択に戻ります。
 * 
 * 
 *-----------------------------------------------------------------------------
 * 参考情報1:動作確認済みのイベントコマンド
 *-----------------------------------------------------------------------------
 * ・変数の操作
 * ・ウェイト
 * ・メッセージの表示(文章、選択肢、数値入力、アイテム選択、スクロール)
 * ・ピクチャの表示・消去
 * 
 * 
 *-----------------------------------------------------------------------------
 * 参考情報2:メッセージウィンドウとピクチャの表示優先度について
 *-----------------------------------------------------------------------------
 * イベントコマンドで表示可能な、メッセージウィンドウとピクチャの表示優先度は
 * 以下の通りです。(デフォルト設定の場合)
 * 
 *    優先度小------------------------------優先度大
 *    メニュー画面 < メッセージウィンドウ < ピクチャ
 * 
 * 優先度が大きい方が、重なったときに前面に表示されます。
 * 
 * プラグインパラメータ「Display priority」で、メッセージウィンドウとピクチャの
 * 表示優先度を変更することができます。
 * 
 * 
 *-----------------------------------------------------------------------------
 * 参考情報3:実行できないイベントコマンド
 *-----------------------------------------------------------------------------
 * ・タイマーの操作
 * ・アニメーションの表示
 * ・イベントやプレイヤーを対象とした移動、表示操作
 * 
 * 
 *-----------------------------------------------------------------------------
 * !!メッセージウィンドウを前面表示にした場合の注意点!!
 *-----------------------------------------------------------------------------
 * メッセージウィンドウの透過度によっては、背面側のメニュー画面が透過して見える
 * ようになります。
 * (通常、ウィンドウ同士が重なった場合は、背面側のウィンドウは見えない)
 * 
 * 透過して見えないようにしたい場合は、ウィンドウの背面にピクチャを表示して
 * メニュー画面を隠すなどしてください。
 * 
 * 
 * この設定の場合、プラグインパラメータ「Menu Message Window」で
 * 以下のウィンドウの設定を変更できます。
 * ※ウィンドウごとに個別に設定することはできません。
 * 
 *    <対象ウィンドウ>
 *      メッセージウィンドウ
 *      選択肢ウィンドウ
 *      数値入力ウィンドウ
 *      アイテム選択ウィンドウ
 *      スクロールウィンドウ(フォントサイズ、行の高さのみ有効)
 * 
 * 他のメッセージ系のプラグインと競合する場合には、「Menu Message Window」の
 * パラメータの入力を「テキスト」に選択し、空欄にしてください。
 * 
 * 
 *-----------------------------------------------------------------------------
 * 本プラグインのライセンスについて(License)
 *-----------------------------------------------------------------------------
 * 本プラグインはMITライセンスのもとで公開しています。
 * This plugin is released under the MIT License.
 * 
 * Copyright (c) 2017,2018 Futokoro
 * http://opensource.org/licenses/mit-license.php
 * 
 * 
 * プラグイン公開元
 * https://github.com/futokoro/RPGMaker/blob/master/README.md
 * 
 * 
 *-----------------------------------------------------------------------------
 * 変更来歴
 *-----------------------------------------------------------------------------
 * 
 * v1.1.0 - 2018/10/05 : 機能追加
 *    1. メッセージウィンドウの設定を無効にする機能を追加。
 * 
 * v1.0.3 - 2018/02/20 : 不具合修正
 *    1. 範囲が「なし」のアイテムのコモンイベントで、メッセージウィンドウを
 *       表示させたときに、イベントを正しく実行できない不具合を修正。
 * 
 * v1.0.2 - 2017/12/02 : 仕様変更, 機能追加
 *    1. コモンイベント実行時に選択中のアイテムの所持数が0になった場合、
 *       アイテム選択画面に戻るように修正。
 *    2. 選択画面に戻るときに、アイテムリスト画面を更新する処理を追加。
 *    3. メニュー上のイベント実行可否について、アイテム使用時と、サブコマンドの
 *       カスタムコマンド実行時で、別に設定できるように変更。
 *    4. アイテムウィンドウの自動更新機能およびプラグインコマンド追加。
 *    5. メニュー表示中のタイマー機能を削除。
 * 
 * v1.0.1 - 2017/11/28 : 不具合修正、機能追加。
 *    1. プラグインコマンドの不具合修正。
 *    2. Menu Message Windowを空欄にした場合に、機能を無効にするように修正。
 * 
 * v1.0.0 - 2017/11/27 : 初版作成
 * 
 *-----------------------------------------------------------------------------
*/
//=============================================================================
/*~struct~menu:
* @param Window_Skin
* @desc ウィンドウスキンに使用する画像
* @require 1
* @dir img/system/
* @type file
* @default Window
* 
* @param Font_Size
* @desc フォントサイズ
* @type number
* @default 28
* 
* @param Window_Padding
* @desc ウィンドウの周囲の余白
* @type number
* @min 0
* @default 18
* 
* @param Window_Line_Height
* @desc ウィンドウ内の1行の高さ
* @type number
* @default 36
* 
* @param Window_Opacity
* @desc ウィンドウ内の背景の透明度
* 0 - 透明, 255 - 不透明
* @type number
* @min 0
* @max 255
* @default 192
* 
* @param Hide_Window_Frame
* @desc ウィンドウ枠を非表示にするか
* @type boolean
* @on 非表示にする
* @off 表示する
* @default false
*/

スポンサードリンク

スポンサードリンク

Copyright© #ツクプラ , 2021 All Rights Reserved.