Keke ビネット画像を生成・操作 - Keke_VignetteEffect.js
シェア用テキスト：
▼Keke ビネット画像を生成・操作（ケケー様作） - Keke_VignetteEffect.js
https://plugin-mz.fungamemake.com/archives/4112
ビネット・アイリスエフェクトを設定できます。
ふりがな：びねっとがぞうをせいせい・そうさ
機能概要： ビネット・アイリスエフェクトを設定できます。
利用規約（ライセンス）： MITライセンス
作者：ケケー
作者サイト：https://kekeelabo.com/
解説ページ：https://kekeelabo.com/?i=22
ファイル名：Keke_VignetteEffect.js
プラグインのヘルプ：
/*: * @target MZ * @plugindesc ビネット画像を生成・操作 * @author ケケー * * @help * 【ver.2.4.2】 * 中抜き画像を生成し表示するビネットエフェクト * + ビネットを滑らかに変化させるアイリスエフェクト * * * * ◉特徴 ◉ * * ■ビネットエフェクト * ◎色・大きさ・形など自由に設定できる * ◎アニメーションをさせられる * ◎特定のキャラを自動追尾させられる * ◎画像を用意しなくても使える * ◎好きな画像を使うこともできる * ◎マップ・バトル両用 * * ■アイリスエフェクト * ◎ビネットを滑らかに形状変化させられる * ◎画面を色々な形で閉じたり広げたりできる * ◎トランジションにもなる * * * * ◉使い方 ◉ * * * ■【基本1】ビネットを表示する * => プラグインコマンド → ビネット表示 * ◎特定の図形で中抜きにした画像を生成し表示する * ◎ビネットは同時に何個でも表示できる * ◎名前を設定しなくても表示できるが、 * 設定しておいた方がアイリスエフェクト等で対象ビネットを指定しやすい * ◎『ピクチャ使用』で好きな画像を使える。使わなければ無地画像になる * あらかじめ プラグインパラメータ → ピクチャ登録 で * ピクチャを登録しておく必要がある * ◎『ビネット持ち越し』を true にするとシーン移動しても消えなくなる * 消す時はプラグインコマンド『ビネット削除』を使って手動で * * * * ■【基本2】アイリスエフェクトを開始する * => プラグインコマンド → アイリスエフェクト * ◎ビネットを滑らかに形状変化させていくエフェクト * ◎あらかじめビネットを表示しておく必要がある * ◎対象ビネットを指定して実行する。ビネット名を設定しておくと指定しやすい * ◎変化させたい項目だけ入力する。その他は空欄のままでよい * 内枠-半径Xを 0 にすれば、半径Xが 0 に向かって変化していく * ◎アイリスエフェクトは一度にひとつしか実行できない * 複数設定するとひとつずつ順番に実行される * ◎『アニメ枚数』で動きの滑らかさを調整できる * 枚数が多いほど滑らかだが重い。15枚以下を推奨 * * * * ■【基本3】ビネットを移動・拡縮・回転させる * => プラグインコマンド → ビネット操作 * ◎ビネットを自在に操作できる * ◎あらかじめビネットを表示しておく必要がある * ◎対象ビネットを指定して実行する。ビネット名を設定しておくと指定しやすい * ◎変化させたい項目だけ入力する。その他は空欄のままでよい * ずらしXを 0 にすれば、ずらしXが 0 に向かって変化していく * * * * ■【基本4】ビネットの設定を変更する * => プラグインコマンド → ビネット設定変更 * ◎ビネットの各種設定を変更できる * ◎あらかじめビネットを表示しておく必要がある * ◎対象ビネットを指定して実行する。ビネット名を設定しておくと指定しやすい * ◎変化させたい項目だけ入力する。その他は空欄のままでよい * * * * ■【基本5】ビネットを削除する * => プラグインコマンド → ビネット削除 * ◎全て消すか、指定のビネットだけを消すか * ビネット名を設定しておくと指定しやすい * * * * ■【応用】ビネットコモン/アイリスコモン * ◎あらかじめコモンを登録しておき、 * ビネット表示とアイリスコモンを手軽に実行できる * [1] プラグインパラメータ → コモン登録 でコモンを登録 * [2] プラグインコマンド → ビネットコモン/アイリスコモン で実行 * ◎実行する際は、『呼び出すコモン』の欄に登録したコモン名を書く * ◎コモンはパラパラアニメのような画像の連続体になっている * そのうちの1枚を抜き出すのがビネットコモン * 連続して再生するのがアイリスコモン * ◎ビネットコモン『取得ポイント』で、どの位置の画像を取得するか選べる * ◎アイリスコモン『開始ポイント』『終了ポイント』で、 * どの位置から再生を開始し、終了するか設定できる。逆再生も可能 * * * * ★【補足】開始時に適用 * ◎プラグインコマンドの『開始時に適用』を true にすると、 * シーン開始時に自動的に実行される * ◎イベントを自動実行する必要はない * 自動実行すると2回実行されてしまうので注意 * ◎イベントの有効なページに置く必要がある * バトルの場合はバトルイベントの1ページ目 * ◎自動実行よりも実行が早いのが特徴 * 開始後ただちに適用したい処理に * * * * ◉利用規約 ◉ * MITライセンスのもと、自由に使ってくれて大丈夫です * * * * * * @param ピクチャ登録 * @desc ビネット画像として使用するピクチャを登録する * @type struct<picture>[] * @default * * @param コモン登録 * @desc ビネットのコモンを登録する。パラパラアニメのような複数の画像で構成される * @type struct<vignetteCommon>[] * @default * * * * * * @command ビネット表示 * @desc ビネットを表示する * * @arg タグ * @desc 何を書いてもいい欄 * * @arg ビネット名 * @desc ビネットに付ける名前。アイリスエフェクト・ビネット消去で対象ビネットを指定するのに使う * * @arg 開始時に適用 * @desc シーン開始時に自動的に実行する * @type boolean * @default false * * @arg レイヤー * @desc 配置するレイヤー。A はキャラより下、B はキャラより上、Cはピクチャより上。数字が大きいほど上に表示 * @type select * @option レイヤーA1 * @option レイヤーA2 * @option レイヤーA3 * @option レイヤーB1 * @option レイヤーB2 * @option レイヤーB3 * @option レイヤーC1 * @option レイヤーC2 * @option レイヤーC3 * @default レイヤーB1 * * @arg …挿入位置 * @desc 既存のビネットの上に表示するか、下に表示するか * @type select * @option 上 * @option 下 * @default 上 * * @arg フェードイン時間 * @desc ビネットの出現フェード時間。5 なら 5フレーム * @default 0 * * @arg …動作中ウェイト * @desc フェードインが完了するまで待つ * @type boolean * @default false * * @arg ビネット持ち越し * @desc マップ移動・戦闘移行時にビネットを消さずに持ち越す * @type boolean * @default false * * @arg ピクチャ使用 * @desc ピクチャを使用する。プラグインパラメータでピクチャを登録→その名前を書く。v[番号]で変数使用可能 * * @arg 内枠-フォーム * @desc ビネット内枠の形状 * @type select * @option スクエア * @option 真円 * @option 楕円 * @option 横アーモンド * @option 縦アーモンド * @option ダイヤ * @option ギザギザ * @option ギザギザ-滑らか * @option 上下帯 * @option 左右帯 * @option 上帯 * @option 下帯 * @option 左帯 * @option 右帯 * @option フリー * @default スクエア * * @arg …フォーム設定 * @desc 各形状に関する詳細な設定 * @type struct<formCfg> * * @arg 内枠-半径X * @desc ビネット内枠の横半径。50 なら 画面横サイズの 50% * @default 45 * * @arg 内枠-半径Y * @desc ビネット内枠の縦半径。50 なら 画面縦サイズの 50% * @default 45 * * @arg カラー赤 * @desc ビネットの赤み。0〜255 * @default 0 * * @arg カラー緑 * @desc ビネットの緑み。0〜255 * @default 0 * * @arg カラー青 * @desc ビネットの青み。0〜255 * @default 0 * * @arg ぼかし度 * @desc ビネットのぼかしの強さ。0〜 * @default 5 * * @arg 不透明度 * @desc ビネットの不透明度。0〜255 * @default 255 * * @arg ずらしX * @desc ビネットの横ずらし。5 なら右に 5ピクセル * @default 0 * * @arg ずらしY * @desc ビネットの縦ずらし。5 なら下に 5ピクセル * @default 0 * * @arg スケールX * @desc ビネットの横拡大率。1.5 なら 1.5倍 * @default 1 * * @arg スケールY * @desc ビネットを縦拡大率。1.5 なら 1.5倍 * @default 1 * * @arg 回転角 * @desc ビネットを回転角。0〜360。90 で右に 90度、-90 で左に 90度 * @default 0 * * @arg アニメーション * @desc アニメーションの設定をする。拡縮アニメと明滅アニメ * @type struct<animation> * @default * * @arg 追尾設定 * @desc 特定のキャラクターが常に中央に来るように追尾する。マップ時のみ * @type struct<chaseParam> * @default * * * * * @command アイリスエフェクト * @desc ビネットを滑らかに形状変化させる * * @arg タグ * @desc 何を書いてもいい欄 * * @arg 開始時に適用 * @desc シーン開始時に自動的に実行する * @type boolean * @default false * * @arg 対象ビネット-名前 * @desc 名前で対象ビネットを指定する。名前は表示時に設定したもの。, で区切って複数指定できる * * @arg 対象ビネット-ID * @desc IDで対象ビネットを指定する。IDは下に表示されてるのから順に 1〜。, で区切って複数指定できる * * @arg 動作時間 * @desc アイリスエフェクトの所用時間。5 なら 5フレーム * @default 20 * * @arg …アニメ枚数 * @desc アイリスエフェクトに使う画像の枚数。多いほど変化が滑らかだが、読み込みに時間がかかる。15以下推奨 * @default 10 * * @arg …動作中ウェイト * @desc エフェクトが完了するまで待つ * @type boolean * @default false * * @arg 止めずに読み込み * @desc ゲームを止めずにデータを読み込む。止めないぶん少し読み込みが遅くなる * @type boolean * @default false * * @arg 実行後消去 * @desc エフェクト実行後に自動的にビネットを消去する * @type boolean * @default false * * @arg イージング * @desc エフェクトに緩急をつける。イージング:遅→速→遅、イージングイン:遅→速、イージングアウト:速→遅 * @type select * @option イージング無し * @option イージング * @option イージングイン * @option イージングアウト * @default イージング * * @arg 内枠-フォーム * @desc ビネット内枠の形状を変更する * @type select * @option スクエア * @option 真円 * @option 楕円 * @option 横アーモンド * @option 縦アーモンド * @option ダイヤ * @option ギザギザ * @option 上下帯 * @option 左右帯 * @option 上帯 * @option 下帯 * @option 左帯 * @option 右帯 * @option フリー * * @arg …フォーム設定 * @desc 各形状に関する詳細な設定 * @type struct<formCfg> * * @arg 内枠-半径X * @desc ビネットの内枠横半径を変える。50 なら 画面横サイズの 50% にする * * @arg 内枠-半径Y * @desc ビネットの内枠縦半径を変える。50 なら 画面縦サイズの 50% にする * * @arg カラー赤 * @desc ビネットの赤みを変える。0〜255 * * @arg カラー緑 * @desc ビネットの緑みを変える。0〜255。 * * @arg カラー青 * @desc ビネットの青みを変える。0〜255 * * @arg ぼかし度 * @desc ビネットのぼかし度を変える。0〜 * * @arg 不透明度 * @desc ビネットの不透明度を変える。0〜255 * * @arg ずらしX * @desc ビネットを横にずらす。5 なら右に 5ピクセル にする。即座に変わる * * @arg ずらしY * @desc ビネットを縦にずらす。5 なら下に 5ピクセル にする。即座に変わる * * * * * @command ビネット操作 * @desc ビネットを移動・拡大・回転させる * * @arg タグ * @desc 何を書いてもいい欄 * * @arg 開始時に適用 * @desc シーン開始時に自動的に実行する * @type boolean * @default false * * @arg 対象ビネット-名前 * @desc 名前で対象ビネットを指定する。名前は表示時に設定したもの。, で区切って複数指定できる * * @arg 対象ビネット-ID * @desc IDで対象ビネットを指定する。IDは下に表示されてるのから順に 1〜。, で区切って複数指定できる * * @arg 動作時間 * @desc アイリスエフェクトの所用時間。5 なら 5フレーム * @default 20 * * @arg …動作中ウェイト * @desc エフェクトが完了するまで待つ * @type boolean * @default false * * @arg イージング * @desc エフェクトに緩急をつける。イージング:遅→速→遅、イージングアウト:速→遅、イージングイン:遅→速 * @type select * @option イージング無し * @option イージング * @option イージングアウト * @option イージングイン * @default イージング * * @arg ずらしX * @desc ビネットを横にずらす。5 なら右に 5ピクセル にする * * @arg ずらしY * @desc ビネットを縦にずらす。5 なら下に 5ピクセル にする * * @arg スケールX * @desc ビネットを横に拡大する。1.5 なら 1.5倍 にする * * @arg スケールY * @desc ビネットを縦に拡大する。1.5 なら 1.5倍 にする * * @arg 回転角 * @desc ビネットを回転させる。0〜360。90 で右に 90度、-90 で左に 90度 にする * * * * * @command ビネット設定変更 * @desc ビネットの追尾とアニメーションの設定を変更する * * @arg タグ * @desc 何を書いてもいい欄 * * @arg 開始時に適用 * @desc シーン開始時に自動的に実行する * @type boolean * @default false * * @arg 対象ビネット-名前 * @desc 名前で対象ビネットを指定する。名前は表示時に設定したもの。, で区切って複数指定できる * * @arg 対象ビネット-ID * @desc IDで対象ビネットを指定する。IDは下に表示されてるのから順に 1〜。, で区切って複数指定できる * * @arg ビネット持ち越し * @desc マップ移動・戦闘移行時にビネットを消さずに持ち越す * @type boolean * @default * * @arg アニメーション * @desc アニメーションの変更をする。拡縮アニメと明滅アニメ * @type struct<animation> * @default * * @arg 追尾設定 * @desc 特定のキャラクターが常に中央に来るように追尾する。マップ時のみ * @type struct<chaseParam> * @default * * * * * @command ビネットコモン * @desc ビネットコモンを呼び出す * * @arg タグ * @desc 何を書いてもいい欄 * * @arg ビネット名 * @desc ビネットに付ける名前。アイリスエフェクト・ビネット消去で対象ビネットを指定するのに使う * * @arg 開始時に適用 * @desc シーン開始時に自動的に実行する * @type boolean * @default false * * @arg 呼び出すコモン * @desc 呼び出すコモン。プラグインパラメータ→ビネットコモン で登録し、そのコモン名を書く。v[番号]で変数使用可能 * * @arg …取得ポイント * @desc ビネットコモンのどの地点の画像を取得するか。50 なら 50%地点 * @default 0 * * @arg レイヤー * @desc 配置するレイヤー。A はキャラより下、B はキャラより上、Cはピクチャより上。数字が大きいほど上に表示 * @type select * @option レイヤーA1 * @option レイヤーA2 * @option レイヤーA3 * @option レイヤーB1 * @option レイヤーB2 * @option レイヤーB3 * @option レイヤーC1 * @option レイヤーC2 * @option レイヤーC3 * @default レイヤーB1 * * @arg …挿入位置 * @desc 既存のビネットの上に表示するか、下に表示するか * @type select * @option 上 * @option 下 * @default 上 * * @arg フェードイン時間 * @desc ビネットの出現フェード時間。5 なら 5フレーム * @default 0 * * @arg …動作中ウェイト * @desc フェードインが完了するまで待つ * @type boolean * @default false * * @arg ビネット持ち越し * @desc マップ移動・戦闘移行時にビネットを消さずに持ち越す * @type boolean * @default false * * @arg カラー赤 * @desc ビネットの赤み。0〜255 * @default 0 * * @arg カラー緑 * @desc ビネットの緑み。0〜255 * @default 0 * * @arg カラー青 * @desc ビネットの青み。0〜255 * @default 0 * * @arg 不透明度 * @desc ビネットの不透明度。0〜255 * @default 255 * * @arg ずらしX * @desc ビネットを横にずらす。5 なら右に 5ピクセル ずらす * @default 0 * * @arg ずらしY * @desc ビネットを縦にずらす。5 なら下に 5ピクセル ずらす * @default 0 * * @arg スケールX * @desc ビネットを横に拡大する。1.5 なら 1.5倍 * @default 1 * * @arg スケールY * @desc ビネットを縦に拡大する。1.5 なら 1.5倍 * @default 1 * * @arg 回転角 * @desc ビネットを回転させる。0〜360。90 で右に 90度、-90 で左に 90度 * @default 0 * * @arg アニメーション * @desc アニメーションの設定をする。拡縮アニメと明滅アニメ * @type struct<animation> * @default * * @arg 追尾設定 * @desc 特定のキャラクターが常に中央に来るように追尾する。マップ時のみ * @type struct<chaseParam> * @default * * * * * @command アイリスコモン * @desc アイリスコモンを呼び出す * * @arg タグ * @desc 何を書いてもいい欄 * * @arg 開始時に適用 * @desc シーン開始時に自動的に実行する * @type boolean * @default false * * @arg 対象ビネット-名前 * @desc 名前で対象ビネットを指定する。名前は表示時に設定したもの。, で区切って複数指定できる * * @arg 対象ビネット-ID * @desc IDで対象ビネットを指定する。IDは下に表示されてるのから順に 1〜。, で区切って複数指定できる * * @arg 呼び出すコモン * @desc 呼び出すコモンの名前。プラグインパラメータ→ビネットコモン で登録し、そのコモン名を書く。v[番号]で変数使用可能 * * @arg …開始ポイント * @desc ビネットコモンの開始点。50 なら 50%地点 から開始 * @default 0 * * @arg …終了ポイント * @desc ビネットコモンの終了点。50 なら 50%地点で終了 * @default 100 * * @arg 動作時間 * @desc アイリスエフェクトの所用時間。5 なら 5フレーム * @default 20 * * @arg …動作中ウェイト * @desc エフェクトが完了するまで待つ * @type boolean * @default false * * @arg 止めずに読み込み * @desc ゲームを止めずにデータを読み込む。止めないぶん少し読み込みが遅くなる * @type boolean * @default false * * @arg 実行後消去 * @desc エフェクト実行後に自動的にビネットを消去する * @type boolean * @default false * * @arg カラー赤 * @desc ビネットの赤みを変える。0〜255 * * @arg カラー緑 * @desc ビネットの緑みを変える。0〜255 * * @arg カラー青 * @desc ビネットの青みを変える。0〜255 * * @arg 不透明度 * @desc ビネットの不透明度を変える。0〜255 * * @arg ずらしX * @desc ビネットを横にずらす。5 なら右に 5ピクセル にする。即座に変わる * * @arg ずらしY * @desc ビネットを縦にずらす。5 なら下に 5ピクセル にする。即座に変わる * * * * * @command ビネット削除 * @desc ビネットを削除する * * @arg タグ * @desc 何を書いてもいい欄 * * @arg フェードアウト時間 * @desc ビネットの消去フェード時間。5 なら 5フレーム * @default 0 * * @arg …動作中ウェイト * @desc フェードアウトが完了するまで待つ * @type boolean * @default false * * @arg 名前で削除 * @desc ビネット名でビネットを選択し削除する, で区切って複数指定可能 * * @arg IDで削除 * @desc IDでビネットを選択し削除する。IDは下に表示されてるのから順に 1〜。, で区切って複数指定できる * * @arg すべて削除 * @desc 全てのビネットを削除する * @type boolean * @default false */