立体的な影を表示するプラグイン – TsumioEventsShadow.js

タイトル
立体的な影を表示するプラグイン
作者名
ヘルプ
立体的な影を表示するプラグインです。

【特徴】
・イベントに立体的な影を表示させます。
・位置・色・角度の指定ができます。
・影の表示/非表示は任意のタイミングで切り替えられます。

【使用方法】
プラグインの導入後、プラグインパラメーターを設定することによって使用できます。
また、プラグインコマンドから影の操作が可能です。

影を適用したいイベントのメモ欄に「<onShadow>」を記述してください。

【プラグインコマンド】
全てのプラグインコマンドは「TES」から始まります。
また、説明上では視認性のためにカギカッコを使用していますが、実際にプラグインコマンドに入力する際には
カギカッコの入力は不要です。

全てのプラグインコマンドは大文字と小文字を区別します。
各単語の間は半角スペースで区切ります(全角では認識しません)。
間違わないように気をつけてください。

「TES on イベント番号」 : 指定されたイベントの影を表示します。
「TES off イベント番号」 : 指定されたイベントの影を非表示にします。
「TES setColor イベント番号 赤 緑 青 灰」 : 指定されたイベントの色を変更します。【色の数値】も参照してください。
「TES setPos イベント番号 アンカーX アンカーY」 : 指定されたイベントの位置を変更します。【アンカー】も参照してください。
「TES rotate イベント番号 角度」 : 指定されたイベントの角度を変更します。【角度】も参照してください。
「TES save」 : 現在の影の設定を保存します。【セーブと解放】も参照してください。
「TES dispose」 : 現在の影の設定を破棄します。 【セーブと解放】も参照してください。
「TES autoSave true/false」 : オートセーブの有効/無効を設定します。【オートセーブ】も参照してください。

なお、イベント番号に「this」を指定した場合、プラグインコマンドを実行したイベントのイベント番号が代入されます。

【色の数値】
色はデフォルトで
赤:-150
緑:-150
青:-150
灰:255
が指定されています。
参考にしてください。

【アンカー】
アンカーは基準点からの相対的な位置を示します。
通常のイベントのアンカーはX:0.5 Y:1.0に設定されており、イベントの影のアンカーはX:0.6 Y:1.0に設定されます(左側設定の場合)。

アンカーは通常-1.0から1.0の間で指定します。
これより大きい、または小さな値でも問題ありません。

【角度】
角度はラジアンで指定します。
プラグインコマンドrotateのみ、Mathなどのビルトインオブジェクトが使用できます。
例えば円周率を指定したい場合、Math.PIが利用できます。
参考URL: https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Math

【セーブと解放】
プラグインコマンドで影を変更したあと、メニュー画面を開いてマップ画面に戻ると影の設定が初期値に戻ってしまいます。
この現象を避けるために、任意のタイミングでプラグインコマンド「TES save」を実行してください。
プラグインコマンド「TES save」を実行すると、現在の影の設定が保存されます。
また、プラグインコマンド「TES dispose」を実行することにより、現在の影の設定を破棄できます。

保存された影の設定は、イベントコマンドの「場所移動」時に自動で破棄されます。
影の設定はセーブデータにも保存されません。
必要があればイベントの自動実行などを用いて影の再設定をするようにしてください。

【オートセーブ】
プラグインコマンドからオートセーブを有効にした場合(「TES autoSave true」)、各コマンドを実行したタイミングで「TES save」と同等の機能が実行されます。
ただしオートセーブを有効にしたタイミングで「TES save」が実行されるわけではありません。
また、無効化(「TES autoSave false」)したタイミングで「TES dispose」が実行されるわけでもありません。

頻繁(1秒間に数回以上)に影の設定を変更する場合、処理が重くなる可能性があるのでオートセーブは無効化することを推奨します。
また、オートセーブの有効/無効は本体のセーブデータに記憶されます。

【更新履歴】
1.0.2 2017/11/29 ヘルプの加筆。
1.0.1 2017/11/25 オートセーブ機能の追加。
1.0.0 2017/11/23 公開。

【備考】
当プラグインを利用したことによるいかなる損害に対しても、制作者は一切の責任を負わないこととします。

【利用規約】
ソースコードの著作権者が自分であると主張しない限り、
作者に無断で改変、再配布が可能です。
利用形態(商用、18禁利用等)についても制限はありません。
自由に使用してください。
パラメータ
param ----基本的な設定----
desc
default

param 影の位置
type select
option 右側
value Right
option 左側
value Left
desc 影の位置を指定します。
default Left

param 影の色
type struct<ShadowColor>
desc 影の色を設定します。
default {"red":"-150","green":"-150","blue":"-150","gray":"255"}

param 影のデフォルト表示
type boolean
desc 全てのイベントに対し、影をデフォルトで表示するかどうかを設定します。
default false

ライセンス表記
当プラグインを利用したことによるいかなる損害に対しても、制作者は一切の責任を負わないこととします。
ソースコードの著作権者が自分であると主張しない限り、
作者に無断で改変、再配布が可能です。
Copyright (c) 2017 Tsumio
This software is released under the MIT License.
http://opensource.org/licenses/mit-license.php

紹介ページ https://github.com/Tsumio/rmmv-plugins/blob/master/plugins/TsumioEventsShadow.js