#freeze
TITLE:メディア関連コマンド（Ver16.5.1）
#contents
~
*背景音（bgm）[#bgm]
背景音 m01 bgm1.ogg 反復
-BGMフォルダ内にあるBGM素材を再生します。
-Ver14.4.0未満においては、複数が存在しないため、名前を設定しません。演出関係のコマンドの対象名には「背景音（vn_sysBGM）」を用いることになります。
Ver14.4.0以降においては、個体名を指定することができます。指定しない場合には「vn_sysBGM」が個体名となります。
-背景音0……音量0の状態で設定します。コマンド「イン」を用いて既定音量にすることができます。
||設定項目|記述の種類|説明|h
||個体名|命名|背景音個体に設定する個体名|
|&color(Red){【必須】};|素材ファイル名|ファイル名|BGMに設定する素材のファイル名|
||反復|設定項目の語句&br;（反復）|ループ再生の適用|
////////////////////////////////////////////////////////////////////////////////////////////////
*効果音（soundEffect）[#soundEffect]
効果音 se01 se01.ogg
-SFXフォルダ内にある効果音素材を再生します。
-効果音0……音量0の状態で設定します。コマンド「イン」を用いて既定音量にすることができます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|名前|命名|効果音素材に設定する個体名|
|&color(Red){【必須】};|素材ファイル名|ファイル名|効果音素材のファイル名|
||反復|設定項目の語句&br;（反復）|ループ再生の適用|
////////////////////////////////////////////////////////////////////////////////////////////////
*ボイス（voice）[#voice]
ボイス fight voice1.ogg 80 braver switch01
-Voicesフォルダ内にある音声素材を再生します。
-コンフィグにおいてトラックバーを用いて音量を個別に調節できるようにする場合には、設定項目「音量数値変数」に既存の変数名を記述します。
設定音量は“「既定音量」×「主音量（%）」×「ボイス音量（%）」×「音量数値変数値（%）」”となります。
項目参照：[[変数>commands/var#var]]
-コンフィグにおいて音声の消音切替を提供したい場合には、設定項目「消音切替変数」に既存の変数名を記述します。
指定した変数の値が「true」であれば設定音量で再生され、「false」になると消音されます。
-バックログは再生されたボイスを最新のテキストに紐づけてボイス再生ボタンでの再生を提供します。
しかし、コンフィグ機能等でボイス例として再生したものがボイス再生ボタンに割り当てられてしまうことがあります。
これを回避するには、設定項目「バックログ登録禁止」を記述しましょう。
-ボイス0……音量0の状態で設定します。コマンド「イン」を用いて設定音量まで上げることができます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|名前|命名|音声素材に設定する個体名|
|&color(Red){【必須】};|素材ファイル名|ファイル名|音声素材のファイル名|
||音量数値変数|個体名|音量の調整時に用いる変数名|
||消音切替変数|個体名|音量の調整時に用いる変数名|
||バックログ登録禁止|設定項目の語句&br;(バックログ登録禁止)|バックログの最新のボイス再生ボタンへの登録・更新を禁止|
////////////////////////////////////////////////////////////////////////////////////////////////
*ボイス再生（voiceReplay）[#voiceReplay]
ボイス再生
-直近に再生したボイス素材をもう一度再生します。
-ボタンの適用コマンドとして設定することを想定していると思われます。
////////////////////////////////////////////////////////////////////////////////////////////////
*背景ボイス（bgvoice）[#bgvoice]
背景ボイス backv roar.ogg mrlion fight
-他のボイス素材が再生される時に音量がゼロになるボイス素材を再生します。
-コンフィグにおいてトラックバーを用いて音量を個別に調節できるようにする場合には、設定項目「音量数値変数」において既存の変数名を記述します。
設定音量は“「既定音量」×「主音量（%）」×「ボイス音量（%）」×「音量数値変数値（%）」”となります。
項目参照：[[変数>commands/var#var]]
-設定項目「フェード時間」を指定すると、音量が瞬間変化ではなく連続変化になります。
-背景ボイス0……音量0の状態で設定します。コマンド「イン」を用いて既定音量にすることができます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|名前|命名|素材に設定する個体名|
|&color(Red){【必須】};|素材ファイル名|ファイル名|音声素材のファイル名|
||音量数値変数|個体名|音量の調整時に用いる変数名|
||音量ゼロ対象の名前の一部|個体名|優先して再生されるボイス素材の個体名|
||フェード時間|数値（単位：ms）|音量切換時のフェード効果時間|
////////////////////////////////////////////////////////////////////////////////////////////////
*自動ボイス登録（setAutoVoice）[#setAutoVoice]
自動ボイス登録 fighter fighter_%04d.ogg 64 volume_fighter
-自動割当音声として、Voicesフォルダ内にある音声素材を一括指定します。''ファイル名のみ異なる場合のコマンド「ボイス」の多数回記述の負担を軽減するためのコマンドです''。
登録した自動割当音声は、コマンド「自動ボイス」で用いることになります。
-設定項目「登録名」は、一括指定する音声素材群の個体名です。これをコマンド「自動ボイス」の「設定済登録名」で指定することになります。
-設定項目「素材ファイル名形式」は、自動割当音声として一括指定する音声素材のファイル名を特別な形式で書くものです。
簡潔に書くならば、「''連番のみ『%(桁数)d』あるいは『%d』と記述したファイル名''」となります。
--「特別な形式」とは、連番の代入部分のみを整数の記述にすることを指します。C++のsprintfの方式に準じています。
整数の記述とは、「%(桁数)d」「%d」のことです。連番のファイルを用意した経験がなければ「%d」が適している場合があるかもしれませんが、基本的には桁数を指定します。
---たとえば、3桁であれば基本的には「%03d」とします。この場合では、001、022、635等の番号が表されていることになります。
4桁の0埋め連番（「0001」「0022」「0635」等）であれば「%04d」とします。12桁の0埋め連番であれば「%012d」とします。
---''0をつけるのは、足りない位に0を入れるため（0埋め）です''。0をつけなければ、足りない位には空白が入るため、ほぼ確実にエラーが出ます。
仮にファイル名の連番部分で0埋めをしていない（「1」「22」「635」等）場合には、今後のために共通桁数の連番にリネームすることをおすすめします。リネームツールで一括変換すればすぐ完了します。
リネームしない場合には「%d」を選びます。これは任意の桁数の整数となります。
--ファイル名の連番以外の共通部分はそのまま記述します。
例スクリプト文の「fighter_%04d.ogg」は、「fighter_(0埋め4桁連番).ogg」を表しており、「fighter_0001.ogg」「fighter_0022.ogg」「fighter_0635.ogg」「fighter_2355.ogg」等の形式を指定することになります。
-設定項目「開始番号」は、自動割当音声に指定する素材ファイル名の連番の開始番号です。この番号から昇順に自動割当を行います。
例スクリプト文においては、「fighter_0064.ogg」から自動割当が行われます。
-コンフィグにおいてトラックバーを用いて音量を個別に調節できるようにする場合には、設定項目「音量数値変数」に既存の変数名を記述します。
設定音量は“「既定音量」×「主音量（%）」×「ボイス音量（%）」×「音量数値変数値（%）」”となります。
項目参照：[[変数>commands/var#var]]
-コンフィグにおいて音声の消音切替を提供したい場合には、設定項目「消音切替変数」に既存の変数名を記述します。
指定した変数の値が「true」であれば設定音量で再生され、「false」になると消音されます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|登録名|命名|自動割当音声に設定する個体名|
|&color(Red){【必須】};|素材ファイル名形式|ファイル名（特殊）|音声素材のファイル名形式|
|&color(Red){【必須】};|開始番号|数値|自動割当音声の連番の開始番号|
||音量数値変数|個体名|音量の調整時に用いる変数名|
||消音切替変数|個体名|音量の調整時に用いる変数名|
////////////////////////////////////////////////////////////////////////////////////////////////
*自動ボイス（autoVoice）[#autoVoice]
自動ボイス v_fighter fighter
-コマンド「自動ボイス登録」で設定した自動割当音声を再生します。
例スクリプト文のような記述を繰り返すだけで自動的に音声が割り振られるため、記述が簡略化されます。
-このコマンドが適用されると、割当番号に合致するファイル名の音声素材が再生され、再生後に1が割当番号に加算されます。
次回適用時には1だけ大きい割当番号に合致するファイル名の音声素材が再生されます。
--コマンド「自動ボイス登録」の例スクリプト文のように設定したあと、上記の例スクリプト文のようにコマンドを適用すると、「fighter_0064.ogg」が再生されます。
次に同様のコマンドを適用すると「fighter_0065.ogg」が、また次には「fighter_0066.ogg」が再生されます。''連番部分が自動加算された素材が割り当てられる''ということです。
-バックログは再生されたボイスを最新のテキストに紐づけてボイス再生ボタンでの再生を提供します。
しかし、コンフィグ機能等でボイス例として再生したものがボイス再生ボタンに割り当てられてしまうことがあります。
これを回避するには、設定項目「バックログ登録禁止」を記述しましょう。
-自動ボイス0……音量0の状態で設定します。コマンド「イン」を用いて設定音量まで上げることができます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|名前|命名|音声に設定する個体名|
|&color(Red){【必須】};|設定済登録名|個体名|設定済の自動割当音声の個体名|
||バックログ登録禁止|設定項目の語句&br;(バックログ登録禁止)|バックログの最新のボイス再生ボタンへの登録・更新を禁止|
////////////////////////////////////////////////////////////////////////////////////////////////
*一時停止（pause）[#pause]
一時停止 背景音
一時停止 "(?!vn_sysBGM)"
-対象の再生・変化を一時停止します。
-Ver8.4.2以前では音声素材の再生の一時停止に限定されていましたが、Ver10.0.0より効果関連コマンドの一時停止に対応しました。
例の2つめは、背景音以外の変化を一時停止します。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|対象名|個体名|一時停止する対象の個体名|
||画面領域範囲|個体名|適用する対象の画面領域名|
////////////////////////////////////////////////////////////////////////////////////////////////
*再生続行（play）[#play]
再生続行 背景音
再生続行 "(?!vn_sysBGM)"
-対象の一時停止を解除します。
-Ver8.4.2以前では音声素材の一時停止の解除に限定されていましたが、Ver10.0.0より効果関連コマンドの一時停止の解除に対応しました。
例の2つめは、背景音以外の変化の一時停止を解除します。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|対象名|個体名|一時停止を解除する対象の個体名|
||画面領域範囲|個体名|適用する対象の画面領域名|
////////////////////////////////////////////////////////////////////////////////////////////////
*音量（volume）[#volume]
音量 背景音 50% 2000 a7
音量2 背景音 -30% 400
-素材の再生時の音量を変更します。
-音量2……音量を相対的に変化させます。例の場合は、背景音の既定音量の70%が適用後の音量になります。
-加速度を設定することができます。
項目参照：[[加速度について>command#command1a4]]
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|対象名|個体名|音量を変更する対象素材の個体名|
|&color(Red){【必須】};|音量|数値（単位付）&br;または&br;数値（符号・単位付）|素材再生時の音量（単位：%）&br;または&br;音量の相対変化量（単位：%）|
||効果時間|数値|音量変更に要する時間（単位：ms）|
||加速度|数値|変化の種類|
////////////////////////////////////////////////////////////////////////////////////////////////
*動画（movie）[#movie]
動画 movie1 opening.mpg 0 0 50
動画 ムービー2 ending.mpg 320 180 999 カメラ付着
-フォルダ「Movies」内にある動画を再生します。
-''Ver10.0.0より、対応形式はビデオ側がMPEG1 Video ("mpeg1")、オーディオ側がMPEG1 Audio Layer II ("mp2")の.mpgファイルに限定されました''。
-画像と同様の効果コマンドを適用することができます（Ver7.6.0でブレンドモード以外の対応完了。Ver14.6.0でブレンドモードも対応）。
-''再生が終了しても自動的に退場するわけではありませんので、必ずコマンド「アウト」を適用してください''。
-動画0……透明度と音量を0に設定します。コマンド「イン」を用いると、透明度は255、音量は主音量へと変更されます。
-コマンド「待機」に設定できるオプションの中に「動画終了」と「干渉可能」があります。
たとえば……
待機 動画終了
というコマンドを動画コマンド以降に設定すると、動画の再生が終了するまでは以降のスクリプトの読み込みをしなくなります。
さらに……
待機 動画終了 干渉可能
というように「干渉可能」を付加すれば、コマンド「続行」によって待機状態を解除し、以降のスクリプトを読み込み始めることができるようになります。
この場合においても、動画の再生が終了した時点からは以降のスクリプトを読み込み始めます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|名前|命名|素材に設定する個体名|
|&color(Red){【必須】};|素材ファイル名|ファイル名|動画として再生するファイル|
|&color(Red){【必須】};|x座標|数値|素材左上の頂点のx座標（左右方向の座標）|
|&color(Red){【必須】};|y座標|数値|素材左上の頂点のy座標（上下方向の座標）|
|&color(Red){【必須】};|表示レイヤー|数値|素材の位置するレイヤー|
||反復|設定項目の語句&br;（反復）|反復再生の適用|
||カメラオプション|※1|カメラに対する反映方法|
※1……「カメラオプション」に関しては項目参照：[[カメラオプションについて>command#command1a5]]
////////////////////////////////////////////////////////////////////////////////////////////////
*動画更新（setMovie）[#setMovie]
動画更新 movie1 dark.mpg
-指定した動画個体の動画素材を指定したものに更新します。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|対象名|個体名|素材を更新する動画個体の個体名|
|&color(Red){【必須】};|素材ファイル名|ファイル名|動画として再生するファイル|
////////////////////////////////////////////////////////////////////////////////////////////////
*動画終了形式（movieFinishType）[#movieFinishType]
動画終了形式 movie1 1
-指定した動画個体の再生を終了した際の動作を指定します。
--「0」……追加処理を行いません。こちらが既定値となっています。
--「1」……最終フレームで停止し、そのフレームを表示し続けます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|対象名|個体名|終了形式を指定する動画個体の個体名|
|&color(Red){【必須】};|終了形式フラグ|数値&br;（0または1）|再生終了時の動作|
////////////////////////////////////////////////////////////////////////////////////////////////
*動画クロマキー（movieChromakey）[#movieChromakey]
動画クロマキー movie1 0 255 0 0.99 0.2 0.2
動画クロマキー false
-指定した動画個体に対してクロマキー合成を行います。
クロマキー合成は、端的に表現すれば「特定の色を透明にする処理」となります。
-クロマキー合成の引数を以下で説明します。
''なお、本項の説明は信頼度がじゅうぶんに担保されてはいません''。
--設定項目「透過色」は、透明にする色のカラーコードを指します。
カラーコードはRGBまたはHEXのいずれかで指定します。
ここで指定した色を基に、エンジンは透過すべき背景領域を識別します。
--設定項目「類似度」は、透過色とする許容度を指します。
指定した類似度によって、実際に透過する領域が設定されます。
--設定項目「なめらかさ」は、背景に対する同化割合を指します。
この値を大きくするほど、動画全体が背景に近くなります。
特に輪郭を背景になじませる際に調整する値です。
--設定項目「流出」は、動画の彩度を調整します。
この値を大きくするほど、彩度は小さくなります。
特に輪郭近傍の透過色（一般的に高彩度）の彩度を低減し、輪郭をなじませる際に調整する値です。
--設定項目「デバッグ」は、設定項目「透過色」によってエンジン側が認識した類似度表示を切換えます。
---「true」にすると、動画はグレースケールで表示されます。
設定項目「類似度」の値を上げてゆくと、この表示で''黒に近い領域から透過対象になります''。
---「false」にすると、動画はクロマキー合成後の状態で表示されます。
既定では「false」として扱われるため、基本的には指定の必要はありません。
-クロマキー合成を設定した個体に対しては、設定項目「使用」のみの指定でクロマキー合成の使用を切換えることができます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|対象名|個体名|素材を更新する動画個体の個体名|
|&color(Red){【必須】};|透過色|数値|透過色のカラーコード（RGBまたはHEX）|
|&color(Red){【必須】};|類似度|数値|透過させる範囲に関わる値|
|&color(Red){【必須】};|なめらかさ|数値|背景への同化割合|
|&color(Red){【必須】};|流出|数値|彩度に関わり、透過色の彩度を低減する値|
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|対象名|個体名|素材を更新する動画個体の個体名|
|&color(Red){【必須】};|使用|true&br;または&br;false|クロマキー合成の使用&br;または&br;クロマキー合成の解除|
////////////////////////////////////////////////////////////////////////////////////////////////
*背景音自動継続（bgmAutoContinue）[#bgmAutoContinue]
背景音自動継続 true
-ある背景音個体の再生中に、同一の音源を素材とする背景音個体を設定する、または同一個体名の背景音個体を再設定する場合において、
先頭から再生するか、コマンドを無視して再生を続けるかのいずれかの動作を設定します。
既定値は「true」です。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|BGMの更新回避&br;または&br;BGMの更新許可|
////////////////////////////////////////////////////////////////////////////////////////////////
*反復区間（loopRegion）[#loopRegion]
反復区間 54000 86000
-BGMの指定区間を反復再生します。
例の場合は、54秒経過後から86秒までの区間が反復されます。
-本コマンドを適用すると、対象の背景音個体は冒頭に戻って再生されます。
||設定項目|記述の種類|説明|h
||対象名|個体名|反復区間を設定する背景音個体|
|&color(Red){【必須】};|反復開始時点|数値|反復区間の開始時点（単位：ms）|
|&color(Red){【必須】};|反復終了時点|数値|反復区間の終了時点（単位：ms）|
////////////////////////////////////////////////////////////////////////////////////////////////
*音源確認機（soundChecker）[#soundChecker]
音源確認機 rescheck01 vn_sysBGM 60000 ジャンプ roleskip
-対象の再生時間が設定した時間を超えた際に、特定のコマンドを実行します。
コマンドの実行が完了すると、確認機は消去されます。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|名前|命名|音源確認機に設定する個体名|
|&color(Red){【必須】};|対象名|個体名|再生時間を計測する対象の個体名|
|&color(Red){【必須】};|検知時間|数値|コマンドを実行する再生時間（単位：ms）|
|&color(Red){【必須】};|適用コマンド|コマンド|検知時間を超えた瞬間に適用するコマンド|
////////////////////////////////////////////////////////////////////////////////////////////////
*同期音（syncSound）[#syncSound]
同期音 loop01 /BGM/bgm01_05.ogg vn_sysBGM
-同期対象と同じ時点を再生する音声個体を設定します。
たとえば、同期対象が1000ms時点を再生していれば、指定した音声素材の1000msが同時に再生されます。
-同期対象が設定項目「反復」によって最初から再生される場合には、音声素材も最初から再生されます。
-音声素材の再生時間は同期対象以上である必要があります。基本的には同じ長さのものを用意します。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|名前|命名|同期音に設定する個体名|
|&color(Red){【必須】};|素材ファイル名|ファイル名|同期音素材のファイル名|
|&color(Red){【必須】};|同期対象名|個体名|同期する対象の個体名|
////////////////////////////////////////////////////////////////////////////////////////////////
*音量ログ（logAmplitude）[#logAmplitude]
音量ログ true
-コマンド「音声絵」等によって音量が取得される際に、その音量をログに記録させます。既定は「false」です。
音量の設定値の参考に用いることが想定されています。
||設定項目|記述の種類|説明|h
|&color(Red){【必須】};|true&br;または&br;false|設定項目の語句&br;（true・false）|音量の記録&br;または&br;音量記録の省略|