WindowTween - ZinWindowTween.js

シェア用テキスト：

▼WindowTween（Huuzin様作） - ZinWindowTween.js
https://plugin-mz.fungamemake.com/archives/2077
ウィンドウの出現や消去の動きをコントロールします。

ふりがな：うぃんどうのしゅつげんやしょうきょのうごきをこんとろーるします。

機能概要： ウィンドウの出現や消去の動きをコントロールします。

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

作者：Huuzin

作者サイト：https://huuzin.net/

解説ページ：https://huuzin.net/2021/01/11/windowtween/

ファイル名：ZinWindowTween.js

プラグインのヘルプ：

//=============================================================================
// RPG Maker MZ - WindowTween
//
// Copyright 2021 Huuzin
// Released under the MIT license
// https://opensource.org/licenses/mit-license.php
//
// ver 1.0.0	Release data: 2021/01/11
//				初版公開(First release)
// 
// https://huuzin.net
// 
//=============================================================================
/*:ja
* @target MZ
* @plugindesc ver 1.0.0 ウィンドウの出現や消去の動きをコントロールします
* @author Huuzin
* @url https://huuzin.net/2021/01/11/windowtween/
* @base ZinTween
* @orderAfter ZinTween
* @base PluginCommonBase
* @orderAfter PluginCommonBase
*
* @help
* ウィンドウの出現や消去の動きをコントロールします。
* 現在はタイトル画面及びメニュー画面に対応しています。
*
* ---使用方法---
* 1. プラグインをONにします。
* 2. 好みに合わせてプラグインパラメータを調整してください。
*
* ---動作確認---
* コアスクリプト：v1.1.1
* 本プラグインの動作にはPluginCommonBaseとZinTweenが必要です。
* PluginCommonBase: https://triacontane.blogspot.com/2020/08/rpgmz.html
* ZinTween: https://huuzin.net/2020/09/06/zintween/

* @param ***基本のトゥイーン***
* @param windowGoldTween
* @text ゴールド画面
* @desc ゴールド画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowHelpTween
* @text ヘルプ画面
* @desc ヘルプ画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”0”,”moveY”:”200”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}


* @param ***メニューのトゥイーン***
* @param windowMenuStatusTween
* @text メインメニューアクター画面
* @desc メインメニューアクター画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”-200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowMenuCommandTween
* @text メインメニューコマンド画面
* @desc メインメニューコマンド画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowItemCategoryTween
* @text アイテムカテゴリ画面
* @desc アイテムカテゴリ画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”-200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowItemListTween
* @text アイテムリスト画面
* @desc アイテムリスト画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}


* @param windowMenuActorTween
* @text アクター選択画面
* @desc アイテム・スキルウインドウのアクター選択画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”50%”,”moveY”:”0”,”alpha”:”255”,”easing”:”OutSine”,”duration”:”0.200”,”delay”:”0”}

* @param windowSkillTypeTween
* @text スキルタイプ画面
* @desc スキルタイプ画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”-200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowSkillStatusTween
* @text スキルステータス画面
* @desc スキルステータス画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”-200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowSkillListTween
* @text スキルリスト画面
* @desc スキルリスト画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowEquipStatusTween
* @text 装備ステータス画面
* @desc 装備ステータス画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”-200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowEquipCommandTween
* @text 装備コマンド画面
* @desc 装備コマンド画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowEquipSlotTween
* @text 装備スロット画面
* @desc 装備スロット画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowStatusTween
* @text ステータス画面
* @desc ステータス画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”-200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowStatusParamTween
* @text ステータスパラメータ画面
* @desc ステータスパラメータ画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowStatusEquipTween
* @text ステータス装備画面
* @desc ステータス装備画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”200”,”moveY”:”0”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.300”,”delay”:”0”}

* @param windowOptionTween
* @text オプション画面
* @desc オプション画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”0”,”moveY”:”200”,”alpha”:”0”,”easing”:”InOutSine”,”duration”:”0.600”,”delay”:”0”}

* @param windowSavefileListTween
* @text セーブファイルリスト画面
* @desc セーブファイルリスト画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”0”,”moveY”:”200”,”alpha”:”0”,”easing”:”OutSine”,”duration”:”0.400”,”delay”:”0.200”}

* @param windowGameEndTween
* @text ゲーム終了コマンド画面
* @desc ゲーム終了コマンド画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”0”,”moveY”:”200”,”alpha”:”0”,”easing”:”InOutSine”,”duration”:”0.600”,”delay”:”0”}

* @param ***タイトルのトゥイーン***
* @param windowTitleCommandTween
* @text タイトルコマンド画面
* @desc タイトルコマンド画面の開閉に適用するトゥイーンの設定
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”0”,”moveY”:”0”,”alpha”:”0”,”easing”:”InOutSine”,”duration”:”1.200”,”delay”:”0”}


* @param ***カスタムトゥイーン***
* @param customTweens
* @text 追加ウィンドウ
* @desc プラグイン等で追加されたウインドウに対してトゥイーンを適用します。
* @type struct<TweenWindow>[]
* @default [”{”windowName”:”_listWindow.mzkp_statusWindow”,”sceneType”:”Save”,”tween”:”{\”enable\”:\”true\”,\”moveX\”:\”0\”,\”moveY\”:\”200\”,\”alpha\”:\”0\”,\”easing\”:\”OutSine\”,\”duration\”:\”0.400\”,\”delay\”:\”0.400\”}”}”]

*
*/

/*~struct~TweenWindow:ja
*
* @param windowName
* @text ウインドウ名
* @desc ウインドウ名を指定します。「対象シーン.{_commandWindow}」の{}内を記述してください。
* @type string
*
* @param sceneType
* @text シーンタイプ
* @desc このトゥイーンを適用するシーンタイプを選択します。
* @type select
* @default MainMenu
* @option メインメニュー(MainMenu)[Scene_Menu]
* @value MainMenu
* @option アイテム画面(MenuItem)[Scene_Item]
* @value MenuItem
* @option アクター選択(SelectActor)[Scene_ItemBase]
* @value SelectActor
* @option スキル画面(MenuSkill)[Scene_Skill]
* @value MenuSkill
* @option 装備画面(MenuEquip)[Scene_Equip]
* @value MenuEquip
* @option ステータス画面(MenuStatus)[Scene_Status]
* @value MenuStatus
* @option セーブ画面(Save)[Scene_File]
* @value Save
* @option ゲーム終了画面(GameEnd)[Scene_GameEnd]
* @value GameEnd
*
* @param tween
* @text カスタムトゥイーン設定
* @desc カスタムトゥイーンを設定します。
* @type struct<TweenSetting>
* @default {”enable”:”true”,”moveX”:”0”,”moveY”:”0”,”alpha”:”0”,”easing”:”InOutSine”,”duration”:”0.3”,”delay”:”0”}
*
*/

/*~struct~TweenSetting:ja
 *
 * @param enable
 * @text トゥイーン許可
 * @desc このトゥイーンを使用するかどうかを指定します。
 * @type boolean
 * @default false
 * 
 * @param moveX
 * @text x座標
 * @desc X移動座標を設定します。
 * @default 0
 * @type string
 * 
 * @param moveY
 * @text y座標
 * @desc Y移動座標を設定します。
 * @default 0
 * @type string
 *
 * @param alpha
 * @text 透過率
 * @desc 透過率を設定します。
 * @default 0
 * @type string
 * 
 * @param easing
 * @text イージング
 * @desc イージングの種類を指定します。
 * @type select
 * @default InOutSine
 * @option 線形変化[Slope]
 * @value Slope
 * @option サインカーブ(入り)[InSine]
 * @value InSine
 * @option サインカーブ(抜き)[OutSine]
 * @value OutSine
 * @option サインカーブ(入り抜き)[InOutSine]
 * @value InOutSine
 * @option 2乗変化(入り)[InQuad]
 * @value InQuad
 * @option 2乗変化(抜き)[OutQuad]
 * @value OutQuad
 * @option 2乗変化(入り抜き)[InOutQuad]
 * @value InOutQuad
 * @option 3乗変化(入り)[InCubic]
 * @value InCubic
 * @option 3乗変化(抜き)[OutCubic]
 * @value OutCubic
 * @option 3乗変化(入り抜き)[InOutCubic]
 * @value InOutCubic
 * @option 4乗変化(入り)[InQuart]
 * @value InQuart
 * @option 4乗変化(抜き)[OutQuart]
 * @value OutQuart
 * @option 4乗変化(入り抜き)[InOutQuart]
 * @value InOutQuart
 * @option 指数変化(入り)[InExpo]
 * @value InExpo
 * @option 指数変化(抜き)[OutExpo]
 * @value OutExpo
 * @option 指数変化(入り抜き)[InOutExpo]
 * @value InOutExpo
 * @option 反動(入り)[InBack]
 * @value InBack
 * @option 反動(抜き)[OutBack]
 * @value OutBack
 * @option 反動(入り抜き)[InOutBack]
 * @value InOutBack
 * @option 弾性(入り)[InElastic]
 * @value InElastic
 * @option 弾性(抜き)[OutElastic]
 * @value OutElastic
 * @option 弾性(入り抜き)[InOutElastic]
 * @value InOutElastic
 * @option バウンス(入り)[InBounce]
 * @value InBounce
 * @option バウンス(抜き)[OutBounce]
 * @value OutBounce
 * @option バウンス(入り抜き)[InOutBounce]
 * @value InOutBounce
 * @option ステップ変化[Step]
 * @value Step
 * @option 階段状変化１[Stairs1]
 * @value Stairs1
 * @option 階段状変化２(ピンポン動作向け)[Stairs2]
 * @value Stairs2
 *
 * @param duration
 * @text イージング時間
 * @desc イージング完了までにかかる時間[秒]
 * @default 0.3
 * @type number
 * @decimals 3
 * 
 * @param delay
 * @text ディレイ
 * @desc イージング開始までのディレイ時間[秒]
 * @default 0
 * @type number
 * @decimals 3
 * 
*/