============================================================
	ルールトランジションマスクプラグイン v1.1.1
============================================================

このプラグインは、ルール画像を用いたトランジション、
吉里吉里でいうところの「ユニバーサルトランジション」を用いた
スクリーンマスクを実行てきるようにするプラグインです。

2023 © STRIKEWORKS All Rights Reserved.


----------------------------------------
	利用規約
----------------------------------------

このプラグイン及びこれに付属する素材は、
ティラノスクリプトまたはティラノビルダーで制作する作品でのみ使用可能です。


----------------------------------------
	禁止事項
----------------------------------------

このプラグインに関する次の行為を禁止いたします。

・プラグインの再配布またはコードの公開
（プラグインを含んだブラウザゲームを配信するのはもちろんOKです）
・プラグインを参照し新しいプラグインとして公開する行為
・他者への譲渡や提供など


----------------------------------------
	開発者・連絡先
----------------------------------------

ティラノスクリプト公式
Mail: http://shikemokumk@gmail.com
Twitter: https://twitter.com/tyranobase


----------------------------------------
	免責事項
----------------------------------------

本プラグインを使用したことによって生じた損害・損失に対して
制作者は一切責任を負いません。


----------------------------------------
	導入方法
----------------------------------------

(1)zipファイルを展開して出てきた「mask_rule」フォルダを、
ティラノスクリプトのプロジェクトフォルダの
「data/others/plugin」フォルダの中にコピーします。
（「init.ks」の場所が「data/others/plugin/mask_rule/init.ks」となるように。）

(2)zipファイルを展開して出てきた「bg_rule_image」フォルダを、
ティラノスクリプトのプロジェクトフォルダの
「data/image」フォルダの中にコピーします。
ルール画像はここに入れるようにしてください。
（たとえばルール画像「001.png」の場所が「data/image/bg_rule_image/001.png」となるように。）

(3)シナリオファイル「first.ks」を開き、
適当な位置に次のタグを書きます（リファレンスは後述）

[plugin name=mask_rule]

以上の手順によって、プラグインの導入が完了します。
プラグインの導入によって[mask_rule]及び[mask_off_rule]タグが使えるようになります。
詳細は以下のタグリファレンスをご参照ください。


----------------------------------------
	タグリファレンス
----------------------------------------

●プラグインの読み込み

〇基本例

    [plugin name=mask_rule]

〇パラメータ一覧

    shortcut :【任意】テキストをスキップしているときに[mask_rule]タグを通過するときに
                      演出を省略するかどうか。trueかfalseで指定する。デフォルトはtrue。

〇応用例

    [plugin name=mask_rule shortcut=false]


●ルールトランジションによるスクリーンマスク表示 [mask_rule]

ゲーム画面全体を画像あるいは特定の色で覆う（暗転する）ことができます。
暗転中にゲーム画面を再構築して[mask_off]タグでマスクを外す、という使い方ができます。

既存の[mask]タグのルールトランジション版であり、
[mask]の代わりにこの[mask_rule]を使うことができます。


〇基本例

    [mask_rule graphic=XXX.jpg rule=XXX.png]

〇パラメータ一覧

    graphic  :【必須】マスク画像ファイル。data/imageフォルダが基準。colorを指定する場合のみ省略できる。
    color    :【任意】マスク色。graphicに代えて色を指定することができる。
    rule     :【必須】ルール画像ファイル。image/bg_rule_imageフォルダに配置。
    time     :【任意】切り替え時間(ミリ秒)。デフォルトは1000。
    reverse  :【任意】ルール画像の白黒を逆向きに処理するかどうか。
                      trueかfalseで指定する。デフォルトはfalse。
    
    folder      :【任意】マスク画像が入っているフォルダを指定する。
                         デフォルトはimage。
    rule_folder :【任意】ルール画像が入っているフォルダを指定する。
                         デフォルトはimage/bg_rule_image。


●ルールトランジションによるスクリーンマスク消去 [mask_off_rule]

かけていたスクリーンマスクをルールトランジションによって消去します。
[mask_off]のルールトランジション版であり、
[mask_off]の代わりにこの[mask_off_rule]を使うことができます。
[mask_rule]→[mask_off]、[mask]→[mask_off_rule]という組み合わせでも使えます。


〇基本例

    [mask_off_rule rule=XXX.png]

〇パラメータ一覧

    rule     :【必須】ルール画像ファイル。image/bg_rule_imageフォルダに配置。
    time     :【任意】切り替え時間(ミリ秒)。デフォルトは1000。
    reverse  :【任意】ルール画像の白黒を逆向きに処理するかどうか。
                      trueかfalseで指定する。デフォルトはfalse。
    rule_folder :【任意】ルール画像が入っているフォルダを指定する。
                         デフォルトはimage/bg_rule_image。


----------------------------------------
	リリースノート
----------------------------------------

1.0.0(2018/09/12)
    公開


----------------------------------------
	ライブラリ
----------------------------------------

このプラグインは次のライブラリを使用しています。

・forked: forked from: Universal Transition - http://jsdo.it/nosemint/9OWJ
　Licensed under the MIT license - http://opensource.org/licenses/MIT