MPP マスクフォグ - MPP_MaskFog.js

シェア用テキスト：

▼MPP マスクフォグ（木星ペンギン様作） - MPP_MaskFog.js
https://plugin-mz.fungamemake.com/archives/5060
マップの前面に部分的に透過できる画像を表示します。

ふりがな：ますくふぉぐ

機能概要： マップの前面に部分的に透過できる画像を表示します。

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

作者：木星ペンギン

作者サイト：https://woodpenguin.web.fc2.com/MV_Plugin/

解説ページ：https://woodpenguin.web.fc2.com/MV_Plugin/MaskFog.html

ファイル名：MPP_MaskFog.js

プラグインのヘルプ：

/*:ja
 * @target MZ
 * @plugindesc マップの前面に部分的に透過できる画像を表示します。
 * @author 木星ペンギン
 * @url 
 *
 * @help [version 1.1.1]
 * このプラグインはRPGツクールMZ用です。
 * 
 * ▼ プラグインコマンド
 *  - 数値を入力する項目で、テキストを選択して v[N] と記述することで
 *    変数N番を参照します。
 *  
 *  〇 フォグ透過設定
 *   - キャラクターを中心に円形の透過を行います。
 *   
 *  〇 フォグ不透明度の移動
 *   - フォグ画像の不透明度を時間をかけて移動します。
 * 
 * ▼ マップのメモ
 *  〇 <MaskFog:xxx>
 *      xxx : フォグ画像名
 *   - マップの前面にフォグ画像を表示します。
 *   - 画像は img/parallaxes フォルダから読み込まれます。
 *   - 遠景と同じく、画像ファイル名の先頭に「!」をつけると視差は0になります。
 * 
 *  〇 <MaskFogScroll:x,y>
 *      x : X軸のスクロール速度
 *      y : Y軸のスクロール速度
 *   - フォグ画像が自動でスクロールします。
 *   - 移動速度や方向はマップの遠景と同じです。
 * 
 *  〇 <MaskFogOpacity:o>
 *      o : 不透明度
 *   - フォグ画像の不透明度を指定します。
 * 
 * ▼ イベントの実行内容の注釈
 *  〇 フォグ透過 r o
 *      r : 半径(1 = 1タイル)
 *      o : 不透明度(0～255で設定)
 *   - このイベントを中心にフォグ画像を円形に透過します。
 * 
 * ================================
 * Mail : wood_penguin＠yahoo.co.jp (＠は半角)
 * Blog : http://woodpenguin.blog.fc2.com/
 * License : MIT license
 * 
 *  @noteParam MaskFog
 *      @noteDir img/parallaxes/
 *      @noteType file
 *      @noteData maps
 * 
 * 
 *  @command setMaskFogCavity
 *      @text フォグ透過設定
 *      @desc 
 *      @arg character
 *          @text 対象キャラクター
 *          @desc -1:プレイヤー, 0:このイベント, 1～:イベントID
 *          @type number
 *              @min -1
 *              @max 999
 *          @default 0
 *      @arg radius
 *          @text 半径
 *          @desc 1 = 1タイル
 *          @type number
 *              @min 0
 *              @max 99
 *              @decimals 1
 *          @default 3.0
 *      @arg opacity
 *          @text 不透明度
 *          @desc 
 *          @type number
 *              @min 0
 *              @max 255
 *          @default 255
 * 
 *  @command moveMaskFogOpacity
 *      @text フォグ不透明度の移動
 *      @desc 
 *      @arg opacity
 *          @text 不透明度
 *          @desc 
 *          @type number
 *              @min 0
 *              @max 255
 *          @default 255
 *      @arg duration
 *          @text 時間
 *          @desc 移動にかける時間をフレーム数で指定
 *          @type number
 *              @min 1
 *              @max 999
 *          @default 60
 * 
 * 
 *  @param Player Defaults
 *      @text プレイヤーのデフォルト値
 *      @desc 
 *      @type struct<PlayerDefaults>
 *      @default {”Radius”:”3.0”,”Opacity”:”255”}
 *
 *  @param Circle Blur
 *      @text ぼかし
 *      @desc 0～100
 *      @type number
 *          @min 0
 *          @max 100
 *      @default 50
 *
 */