//=================================================
// TF_Utility.js
// Version :0.1.3.0
// For : RPGツクールMZ (RPG Maker MZ)
// ----------------------------------------------
// Copyright : Tobishima-Factory 2020-2024
// Website : http://tonbi.jp
//
// This software is released under the MIT License.
// http://opensource.org/licenses/mit-license.php
//=================================================
/*:ja
 * @target MZ
 * @plugindesc [スクリプト]から使いやすいコマンド集
 * @author とんび﹫鳶嶋工房(tonbi.jp)
 * @url https://github.com/tonbijp/RPGMakerMZ/blob/master/TF_Utility.js
 * 
 * @base PluginCommonBase
 * @orderAfter PluginCommonBase
 * @base PluginBaseFunction
 * @base TF_CharEx
 * 
 * @requiredAssets audio/se/Move1
 *
 * @================== command =====================
 * @command beforeMove @text 移動と前処理
 * @desc 一歩前進してフェードアウトを行い、マップを移動する。
 *
 * @arg mapId @text マップID
 * @desc
 * マップID(数値)かマップの名前
 *  現在のマップ: this
 * @type string @default this
 * 
 * @arg pointStr @text 移動先位置(タイル数)
 * @desc 移動先座標(小数点以下可)
 * @type string @default 0,0
 *
 * @arg isMove @text 移動前に前進
 * @type boolean @default true
 * @on 一歩前進(規定) @off 前進なし
 *
 * @arg pitch @text 移動音の音程
 * @desc 数が小さいほど低い音(規定値: 100)
 * @default 100
 *
 * @arg d @text 移動後のキャラの向き
 * @desc (規定値: 0 そのまま)
 * @type select @default 0
 * @option そのまま @value 0
 * @option ↑ @value 8
 * @option ← @value 4
 * @option → @value 6
 * @option ↓ @value 2
 *
 * @================================================
 * @command afterMove @text 移動後の処理
 * @desc フェードインして一歩前進、イベントの一時消去。
 * 
 * @============ この長さに合わせるとヘルプではみ出ない =============
 * @help
 * 移動の前後の処理をカプセル化。
 *
 * ※ PluginCommonBase 定義によりパラメータや引数に \V[n] を使えます。
 */

( () => {
	"use strict";
	// エラー表示用にプラグイン名を取得
	const PLUGIN_NAME = PluginManagerEx.findPluginName( document.currentScript );

	// プラグインコマンド
	const COM_BEFORE_MOVE = "beforeMove";
	const COM_AFTER_MOVE = "afterMove";

	const VOLUME_OFFSET = 5;	//オプション: 音量の最小変更数を5に。

	// イベント指定用の識別子
	const EVENT_THIS = "this";

	// イベントコマンドの番号
	const COMMAND_END = 0;
	const TRANSFER_PLAYER = 201;
	const SET_MOVEMENT_ROUTE = 205;
	const CHANGE_PLAYER_FOLLOWERS = 216;
	const FADEOUT_SCREEN = 221;
	const FADEIN_SCREEN = 222;
	const WAIT_FOR = 230;
	const PLAY_SE = 250;
	const REMOVE_EVENT = 214;

	// イベントコマンドのパラメータ
	const FLAG_ON = 1;
	const FLAG_OFF = 0;
	const PAN_CENTER = 0;
	const LOCATE_DILECT = 0;
	const FADE_TO_BLACK = 0;
	const FADE_TO_WHITE = 1;
	const FADE_NONE = 2;

	const PLAYER_CHARACTER = -1;
	const gc = Game_Character;

	/*---- パラメータパース関数 ----*/


	/**
	 * プラグインコマンドの登録
	 */
	/**
	 * beforeMove
	 * マップ移動前の処理。
	 * @param {String} mapId マップID | マップ名 | this
	 * @param {String} pointStr 座標(タイル数)
	 * @param {Boolean} isMove 一歩前進するか
	 * @param {Number} pitch 音程
	 * @param {Number} d 向き(テンキー対応 | 方向文字列) (規定値: 現在の向き( 0 ))
	 * 
	 */
	PluginManagerEx.registerCommand( document.currentScript, COM_BEFORE_MOVE, function( args ) {
		const pos = stringToPoint( args.pointStr );
		const eventCommands = getMoveMapCommands( args.mapId, pos.x, pos.y, args.d, args.pitch );
		if( args.isMove ) {
			eventCommands.unshift( {
				code: SET_MOVEMENT_ROUTE, parameters: [ PLAYER_CHARACTER, {
					repeat: false, skippable: true, wait: true, list:
						[
							{ code: gc.ROUTE_THROUGH_ON },
							{ code: gc.ROUTE_MOVE_FORWARD },
							{ code: gc.ROUTE_THROUGH_OFF },
							{ code: gc.ROUTE_END }
						]
				} ]
			} );
		}
		this.setupChild( eventCommands, this._eventId );
	} );

	/**
	 * マップ移動前の処理のコマンド配列を返す。
	 * @param {String} mapId マップID | マップ名 | this
	 * @param {String} x x座標(タイル数)
	 * @param {String} y y座標(タイル数)
	 * @param {String} d 向き(テンキー対応 | 方向文字列) (規定値: 現在の向き( 0 ))
	 * @param {Number} pitch ピッチ
	 * @returns {Array} イベントコマンドの配列
	 */
	const MOVE_SE = "Move1";
	const MOVE_VOLUME = 30;
	function getMoveMapCommands( mapId, x, y, d, pitch ) {
		mapId = stringToMapId( mapId );

		return [
			{ code: FADEOUT_SCREEN },
			{ code: CHANGE_PLAYER_FOLLOWERS, parameters: [ FLAG_ON ] },
			{ code: PLAY_SE, parameters: [ { name: MOVE_SE, volume: MOVE_VOLUME, pitch: pitch, pan: PAN_CENTER } ] },
			{ code: TRANSFER_PLAYER, parameters: [ LOCATE_DILECT, mapId, x, y, d, FADE_NONE ] },
			{ code: COMMAND_END }
		];
	}

	/**
	 * afterMove
	 * 移動後のフェードインおよび一歩前進処理を行う
	 */
	PluginManagerEx.registerCommand( document.currentScript, COM_AFTER_MOVE,
		function() {
			this.setupChild( [
				{ code: CHANGE_PLAYER_FOLLOWERS, parameters: [ FLAG_OFF ] },
				{ code: FADEIN_SCREEN },
				{
					code: SET_MOVEMENT_ROUTE, parameters: [ PLAYER_CHARACTER,
						{
							repeat: false, skippable: true, wait: true, list: [
								{ code: gc.ROUTE_THROUGH_ON },
								{ code: gc.ROUTE_MOVE_FORWARD },
								{ code: gc.ROUTE_THROUGH_OFF },
								{ code: gc.ROUTE_DIR_FIX_OFF },
								{ code: gc.ROUTE_END }
							]
						}
					]
				},
				{ code: REMOVE_EVENT },
				{ code: COMMAND_END }
			], this._eventId );
		}
	);


	/*==== 音設定 ====*/
	/*--- Window_Options ---*/
	Window_Options.prototype.volumeOffset = () => VOLUME_OFFSET;


	// 追加キー設定
	// const KEY_BS = 8;
	// const KEY_DEL = 46;
	// const KEY_C = 67;
	// const KEY_M = 77;
	// const ACTION_MENU = "menu";
	// const ACTION_CANCEL = "cancel";
	// Input.keyMapper[ KEY_M ] = ACTION_MENU;
	// Input.keyMapper[ KEY_BS ] = ACTION_CANCEL;
	// Input.keyMapper[ KEY_DEL ] = ACTION_CANCEL;
	// Input.keyMapper[ KEY_C ] = ACTION_CANCEL;

	//  Wを上に割り当てると、メニューでのキャラ切り替えができなくなる
	// const KEY_W = 87;
	// const KEY_A = 65;
	// const KEY_S = 83;
	// const KEY_D = 68;
	// const ACTION_UP = "up";
	// const ACTION_DOWN = "down";
	// const ACTION_LEFT = "left";
	// const ACTION_RIGHT = "right";
	// Input.keyMapper[ KEY_W ] = ACTION_UP;
	// Input.keyMapper[ KEY_A ] = ACTION_LEFT;
	// Input.keyMapper[ KEY_S ] = ACTION_DOWN;
	// Input.keyMapper[ KEY_D ] = ACTION_RIGHT;

	/*--- ユーティリティ関数 ---*/
	const TYPE_STRING = "string";
	/**
	 * 文字列をマップIDへ変換
	 * @param {String} value マップIDの番号か識別子
	 * @returns {Number} マップID
	 */
	function stringToMapId( value ) {
		if( typeof value === TYPE_STRING ) {
			const label = value.toLowerCase();
			if( label === EVENT_THIS ) return $gameMap.mapId();
		}

		const mapObj = DataManager.searchDataItem( $dataMapInfos, "name", value );
		if( mapObj !== 0 ) return mapObj.id;

		const result = parseInt( value, 10 );
		if( isNaN( result ) ) throw Error( `${PLUGIN_NAME}: I can't found the map '${value}'` );
		return result;
	}

	/**
	 * 文字列をPointオブジェクトに変換して返す。
	 * @param {String} pointStr "x, y" 形式の文字列
	 * @returns {Point} 
	 */
	function stringToPoint( pointStr ) {
		const args = pointStr.match( /([-.0-9]+)[^-.0-9]+([-.0-9]+)/ );
		if( args === null ) throw `${PLUGIN_NAME}: wrong parameter "${pointStr}"`;
		return new Point( parseFloat( args[ 1 ] ), parseFloat( args[ 2 ] ) );
	}
} )();