MNKR 汎用ポップアップコアMZ - MNKR_CommonPopupCoreMZ.js

シェア用テキスト：

▼MNKR 汎用ポップアップコアMZ（Yana (改変 munokura)様作） - MNKR_CommonPopupCoreMZ.js
https://plugin-mz.fungamemake.com/archives/1921
汎用的なポップアップの仕組みを提供するためのベースプラグインです。

ふりがな：はんようぽっぷあっぷこあＭＺ

機能概要： 汎用的なポップアップの仕組みを提供するためのベースプラグインです。

利用規約（ライセンス）： MITライセンス

作者：Yana (改変 munokura)

作者サイト：https://fungamemake.com/

解説ページ：https://fungamemake.com/archives/12087

ファイル名：MNKR_CommonPopupCoreMZ.js

プラグインのヘルプ：

/*:
 * @target MZ
 * @url https://raw.githubusercontent.com/munokura/MNKR-MZ-plugins/master/MNKR_CommonPopupCoreMZ.js
 * @plugindesc 汎用的なポップアップの仕組みを提供するためのベースプラグインです。
 * @author Yana (改変 munokura)
 * 
 * @help
 * このプラグインは、汎用的なポップアップの仕組みを提供するプラグインです。
 * このプラグイン単体ではプラグインコマンドを追加する以外の機能はありません。
 * 
 * ------------------------------------------------------
 *  プラグインコマンド
 * ------------------------------------------------------
 * CommonPopup add param1 param2 param3 ・・・
 * 
 * 必要なパラメータのみを指定できます。
 *  例:プレイヤーの上にテストと240フレームポップアップさせる
 * CommonPopup add text:テスト count:240 eventId:-1
 * 
 * パラメータ詳細:
 * text:表示テキスト
 * eventId:表示するイベントのID
 * count:表示時間
 * delay:表示遅延
 * moveX:移動先地点X(相対座標)
 * moveY:移動先地点Y(相対座標)
 * sx:ポップ位置補正X
 * sy:ポップ位置補正Y
 * pattern:表示パターン　0がフェード、-1が横ストレッチ、-2が縦ストレッチ
 * back:-1:透明背景,0:背景カラーのグラデーション
 * bx:テキスト表示位置補正X
 * by:テキスト表示位置補正Y
 * extend:
 *   表示タイミングの調整用配列で指定。
 *   例:extend:[20,50] 20フレーム掛けて出現し、50フレーム目から消え始める。
 * 
 * 本家で未実装のものを追加
 *   backImage:ファイル名（img/pictures内）
 * 
 * 必要性が低いと考え、プラグインコマンドから削除
 *   anchorX:ポップアップ原点X。0イベントの右端。タイル単位。
 *   anchorY:ポップアップ原点Y。0イベントの下端。タイル単位。
 * 
 * 未実装と思われる機能
 *   fixed:画面に固定するか？ true/falseで指定。
 *   slideCount:新しいポップアップが発生した際、上にスライドさせる速度。
 *
 * イベントコマンドのスクリプトを使う場合、
 *
 * this.addPopup([”add”,”text:テスト”,”count:120”…]);
 *
 * のように記述すればスクリプトでポップアップを行うことができます。
 * 同じように、イベントコマンドの移動ルート内のスクリプトで使用する場合、
 *
 * $gameMap._interpreter.addPopup([”add”,”text:テスト”,”count:120”…]);
 *
 * のように記述すれば使用可能です。
 * 
 * ------------------------------------------------------
 * 利用規約
 * ------------------------------------------------------
 *   MITライセンスです。
 *   https://licenses.opensource.jp/MIT/MIT.html
 *   作者に無断で改変、再配布が可能で、
 *   利用形態（商用、18禁利用等）についても制限はありません。
 * 
 * 
 * @command CommonPopupAdd
 * @text ポップアップ表示
 * @desc テキストをポップアップ表示します。
 * 
 * @arg text
 * @type string
 * @text 表示テキスト
 * @desc 表示テキストを入力します。
 * @default 
 * 
 * @arg eventId
 * @type number
 * @min -1
 * @text イベントID
 * @desc 表示するイベントのID。
 * -1:プレイヤー / 0:実行イベント / 1以上:イベントID
 * @default -1
 * 
 * @arg count
 * @type number
 * @text 表示時間
 * @desc ポップアップを完了するまでのフレーム数
 * @default 60
 * 
 * @arg delay
 * @type number
 * @text 表示遅延
 * @desc ポップアップを開始するまでのフレーム数
 * @default 0
 * 
 * @arg moveX
 * @type number
 * @min -9007
 * @max 9007
 * @text 移動先地点X(相対座標)
 * @desc ポップアップ完了時のX位置補正
 * @default 0
 * 
 * @arg moveY
 * @type number
 * @min -9007
 * @max 9007
 * @text 移動先地点Y(相対座標)
 * @desc ポップアップ完了時のY位置補正
 * @default -48
 * 
 * @arg sx
 * @type number
 * @min -9007
 * @max 9007
 * @text ポップ位置補正X
 * @desc ポップアップのX位置補正
 * @default 0
 * 
 * @arg sy
 * @type number
 * @min -9007
 * @max 9007
 * @text ポップ位置補正Y
 * @desc ポップアップのY位置補正
 * @default 0
 * 
 * @arg pattern
 * @type select
 * @option フェード
 * @value Normal
 * @option 横ストレッチ
 * @value Stretch
 * @option 縦ストレッチ
 * @value GrowUp
 * @text 表示パターン
 * @desc ポップアップ表示の変形パターン
 * @default Normal
 * 
 * @arg back
 * @text 背景色
 * @type string
 * @desc 背景色:Red,Green,Blue,Alpha / 透明:-1
 * 例:0, 0, 0, 0.6
 * @default 0,0,0,0.6
 * 
 * @arg backImage
 * @text 背景画像
 * @type file
 * @require 1
 * @dir img/pictures
 * @desc 背景画像を指定します。背景画像を使用すると背景色は無視されます。
 * @default
 * 
 * @arg bx
 * @type number
 * @min -9007
 * @max 9007
 * @text テキスト位置補正X
 * @desc テキストの表示位置補正X
 * @default 0
 * 
 * @arg by
 * @type number
 * @min -9007
 * @max 9007
 * @text テキスト位置補正Y
 * @desc テキストの表示位置補正Y
 * @default 0
 * 
 * @arg extend
 * @type string
 * @text 表示タイミングの調整
 * @desc 表示タイミングの調整用配列で指定。
 * 例:[20,50] 20フレーム掛けて出現し、50フレーム目から消え始める。
 * @default
 * 
 * 
 * @command CommonPopupClear
 * @text ポップアップ消去
 * @desc 表示されているポップアップを消去します。
 */