マスクワイプ演出フィルタープラグイン - CustomMaskTransitionFilter.js

シェア用テキスト：

▼マスクワイプ演出フィルタープラグイン（村人Ａ様作） - CustomMaskTransitionFilter.js
https://plugin-mz.fungamemake.com/archives/8618
マスクワイプ演出フィルタープラグイン

ふりがな：ますくわいぷえんしゅつふぃるたーぷらぐいん

機能概要： マスクワイプ演出フィルタープラグイン

利用規約（ライセンス）：https://www.rpgmaker-script-wiki.xyz/kiyaku.php

作者：村人Ａ

作者サイト：https://www.rpgmaker-script-wiki.xyz/index.php

解説ページ：https://rpgmaker-script-wiki.xyz/CustomMaskTransitionFi…

ファイル名：CustomMaskTransitionFilter.js

プラグインのヘルプ：

* @target MZ
 * @plugindesc マップ画面への移動時に、指定した画像でマスクワイプ演出を追加するプラグインです。
 * @author 村人Ａ
 *
 * @command switchFilter
 * @text マスクワイプON
 * @desc マスクワイプ演出を有効化します。次のマップ移動時に指定画像を用いたマスク演出が発生します。
 *
 * @arg tname
 * @text マスクに使用する画像名
 * @desc マスク用に使用する画像を指定します。白黒の画像をimg/systemフォルダ内に用意してください。
 * @type file
 * @dir img/system
 *
 * @arg speed
 * @text ワイプ速度
 * @desc マスクワイプ時の進行速度を指定します。20を基準値とし、高いほど早くワイプが進行します。
 * @type number
 * @default 20
 *
 * @command endWipe
 * @text マスクワイプOFF
 * @desc マスクワイプ演出を終了します。次のマップ移動時には通常の瞬間切り替えに戻ります。
 *
 * @help
 * ============================================================================
 * ■ 更新履歴
 * ============================================================================
 * 2025/02/13 castToBaseTextureエラー修正
 * 2024/12/21 リリース
 *
 * ============================================================================
 * 概要
 * ============================================================================
 * このプラグインは、マップ移動時に指定したマスク画像を用いて、
 * 「マスクワイプ」演出を追加します。  
 * 通常のマップ切り替えでは即時に新マップが表示されますが、
 * この演出を有効化すると、旧マップが徐々にマスク画像の形状に沿って
 * 新マップへと切り替わる効果を表現できます。
 *
 * ============================================================================
 * プラグインコマンド
 * ============================================================================
 * ● マスクワイプON
 * マスクワイプ演出を有効にします。  
 * 次回のマップ移動時、指定したマスク画像を用いて徐々に新マップが表示され、
 * 独特な切り替え演出を行うことができます。
 *
 * - マスクに使用する画像名 
 *   img/systemフォルダ内の白黒画像を指定してください。  
 *   白い部分が先に切り替わる領域、黒い部分が後に切り替わる領域、  
 *   というようなイメージでご準備ください。
 *
 * - ワイプ速度
 *   20を基準値とし、値が大きいほど切り替えが速く、  
 *   値が小さいほどゆっくり切り替わります。
 *
 * ● マスクワイプOFF
 * マスクワイプ演出を終了します。  
 * 次のマップ移動からは通常通り、即座に新マップへと切り替わるように戻ります。
 *
 * ============================================================================
 * 使用上の注意
 * ============================================================================
 * マスクワイプON実行直後にすぐ場所移動を行わないでください。  
 * 指定したマスク画像が読み込まれるまで、少し時間（約60フレーム）を空けるか、  
 * 別のイベントページを経由してから場所移動を行ってください。
 *
 * 例：
 * ```
 * ◆プラグインコマンド：CustomMaskTransitionFilter， マスクワイプON
 * ：tname: MyMaskImage
 * ：speed: 20
 *
 * --- この後すぐ場所移動はしない。60フレームほどウェイトを入れるか、別イベントで場所移動 ---
 *
 * ◆場所移動：次のマップへ
 * （マスク画像に沿って徐々に新マップが表示される）
 *
 * --- 再び通常表示に戻したい場合 ---
 *
 * ◆プラグインコマンド：CustomMaskTransitionFilter， マスクワイプOFF
 * （次のマップ移動からは即座に切り替え）
 * ```
 *
 * ============================================================================
 * 注意事項
 * ============================================================================
 * - 基本的にはツクールの最新バージョン向けに作っています。
 * - 演出中は描画負荷が増す可能性があります。
 * - 他の画面遷移プラグインや視覚効果プラグインと併用する場合は、
 *   事前に動作テストを行ってください。
 *
 * ============================================================================
 * 不具合報告
 * ============================================================================
 * 不具合はXやメールで報告してください。  
 * Xアカウント：@rpgmaker_villaA  
 * メール：villaa.contact＠gmail.com
 *