MPP マップ灯り - MPP_MapLight.js

シェア用テキスト：

▼MPP マップ灯り（木星ペンギン様作） - MPP_MapLight.js
https://plugin.fungamemake.com/archives/2238
マップの明るさを調整したり、キャラクターの周囲を明るくしたりできます。

ふりがな：まっぷあかり

機能概要： マップの明るさを調整したり、キャラクターの周囲を明るくしたりできます。

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

作者：木星ペンギン

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

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

ファイル名：MPP_MapLight.js

プラグインのヘルプ：

/*:
 * @plugindesc 【ver.1.2】マップの明るさを設定できるようにします。
 * @author 木星ペンギン
 *
 * @help プラグインコマンド:
 *   SetCharLight id r c o a
 *                        # キャラクターを中心に灯りを表示 ※1
 *                          id : イベントID(0:このイベント, -1:プレイヤー)
 *   ShowMapLight id x y  # 座標(x,y)を中心に灯りを作成 ※2
 *                          id : 灯りID(任意の数値)
 *   MoveMapLight id r c o a
 *                        # 指定したIDの灯りを移動 ※1
 *   EraseMapLight id     # 指定したIDの灯りを消去
 *   SetMapDarkness n     # マップの暗さ(0～255で指定 / 高いほど暗くなる)
 *   
 * ※ プラグインコマンドにて指定する値には変数が使用できます。
 *    v[n] と記述することでn番の変数の値を参照します。
 * 
 * マップのメモ:
 *   <Darkness:n>         # マップの暗さ(0～255で指定 / 高いほど暗くなる)
 *   <MapLight id:x,y,r,c,o,a>
 *                        # 座標(x,y)を中心に灯りを表示 ※1
 *                          id : 灯りID(任意の数値 / マップごとに個別)
 * 
 * イベントの実行内容の注釈:
 *   灯り r c o a          # このイベントを中心に灯りを表示 ※1
 * 
 * ※1 設定項目の説明
 *   r : 半径(1で1マス分)
 *   c : 色番号(プラグインパラメータで設定 / 0で消去)
 *   o : 不透明度(0～255で指定 / 未設定は255)
 *   a : 明滅の振れ幅(0.0～1.0で指定 / 0で明滅なし / 未設定は0)
 * 
 * ※2 作成した灯りはエリアチェンジでリセットされます。
 * 
 * ================================
 * ●リージョンIDの配列指定
 *  数値を配列で設定する際、
 *  n-m と表記することでnからmまでの数値を指定できます。
 *  (例 : 1-4,8,10-12 => 1,2,3,4,8,10,11,12)
 * 
 * ================================
 * ▼コマンドの名前変更について
 *  プラグインコマンドや注釈で使用するコマンドは、
 *  プラグインパラメータから変更できます。
 *  
 *  コマンドを短くしたり日本語にしたりなどして、自分が使いやすいようにしてください。
 *  
 *  プラグインコマンドのみ、変更後もデフォルトのコマンドでも動作します。
 * 
 * ================================
 * 制作 : 木星ペンギン
 * URL : http://woodpenguin.blog.fc2.com/
 * 
 * @param Light Colors
 * @type string[]
 * @desc 灯りの色の配列
 * (上から色番号 1,2,3... となります)
 * @default [”255,255,255”,”192,128,64”]
 * 
 * @param Light Level 1 Regions
 * @desc 明るさレベル1のリージョンIDの配列
 * (範囲指定可)
 * @default 1,9,17,25,33,41,49,57
 *
 * @param Light Level 2 Regions
 * @desc 明るさレベル2のリージョンIDの配列
 * (範囲指定可)
 * @default 2,10,18,26,34,42,50,58
 *
 * @param Light Level 3 Regions
 * @desc 明るさレベル3のリージョンIDの配列
 * (範囲指定可)
 * @default 3,11,19,27,35,43,51,59
 *
 * @param Light Level 4 Regions
 * @desc 明るさレベル4のリージョンIDの配列
 * (範囲指定可)
 * @default 4,12,20,28,36,44,52,60
 *
 * @param Light Level 5 Regions
 * @desc 明るさレベル5のリージョンIDの配列
 * (範囲指定可)
 * @default 5,13,21,29,37,45,53,61
 *
 * @param Light Level 6 Regions
 * @desc 明るさレベル6のリージョンIDの配列
 * (範囲指定可)
 * @default 6,14,22,30,38,46,54,62
 *
 * @param Light Level 7 Regions
 * @desc 明るさレベル7のリージョンIDの配列
 * (範囲指定可)
 * @default 7,15,23,31,39,47,55,63
 *
 *
 * @param === Command ===
 * 
 * @param Plugin Commands
 * @type struct<Plugin>
 * @desc プラグインコマンド名
 * @default {”SetCharLight”:”SetCharLight”,”ShowMapLight”:”ShowMapLight”,”MoveMapLight”:”MoveMapLight”,”EraseMapLight”:”EraseMapLight”,”SetMapDarkness”:”SetMapDarkness”}
 * @parent === Command ===
 * 
 * @param Map Metadata
 * @type struct<MapMetadata>
 * @desc マップメモ欄のデータ名
 * @default {”Darkness”:”Darkness”,”MapLight”:”MapLight”}
 * @parent === Command ===
 * 
 * @param Event Comments
 * @type struct<EventComments>
 * @desc イベントメモ欄のデータ名
 * @default {”Light”:”灯り”}
 * @parent === Command ===
 * 
 *
 *
 */

/*~struct~Plugin:
 * @param SetCharacterLight
 * @desc キャラクターの灯りの色
 * @default SetCharacterLight
 * 
 * @param ShowMapLight
 * @desc 座標(x,y)を中心に灯りを作成
 * @default ShowMapLight
 * 
 * @param MoveMapLight
 * @desc 指定したIDの灯りを移動
 * @default MoveMapLight
 * 
 * @param EraseMapLight
 * @desc 指定したIDの灯りを消去
 * @default EraseMapLight
 * 
 * @param SetMapDarkness
 * @desc マップ全体の暗さ
 * @default SetMapDarkness
 * 
 */

/*~struct~MapMetadata:
 * @param Darkness
 * @desc マップの暗さ
 * @default Darkness
 * 
 * @param MapLight
 * @desc 座標(x,y)を中心に灯りを表示
 * @default MapLight
 * 
 */

/*~struct~EventComments:
 * @param Light
 * @desc このイベントを中心に灯りを表示
 * @default 灯り
 */