メディア関連コマンド(Ver12.8.0)

Last-modified: 2021-09-19 (日) 00:58:51


背景音(bgm)

背景音 bgm1.ogg 反復
  • BGMフォルダ内にあるBGM素材を再生します。
  • 複数が存在しないため、名前を設定しません。演出関係のコマンドの対象名には「背景音」を用いることになります。
  • 背景音0……音量0の状態で設定します。コマンド「イン」を用いて既定音量にすることができます。
設定項目記述の種類説明
【必須】素材ファイル名ファイル名BGMに設定する素材のファイル名
反復設定項目の語句
(反復)
ループ再生の適用

効果音(soundEffect)

効果音 se01 se01.ogg
  • SFXフォルダ内にある効果音素材を再生します。
  • 効果音0……音量0の状態で設定します。コマンド「イン」を用いて既定音量にすることができます。
設定項目記述の種類説明
【必須】名前命名効果音素材に設定する個体名
【必須】素材ファイル名ファイル名効果音素材のファイル名
反復設定項目の語句
(反復)
ループ再生の適用

ボイス(voice)

ボイス fight voice1.ogg 80 braver switch01
  • Voicesフォルダ内にある音声素材を再生します。
  • コンフィグにおいてトラックバーを用いて音量を個別に調節できるようにする場合には、設定項目「音量数値変数」に既存の変数名を記述します。
    設定音量は“「既定音量」×「主音量(%)」×「ボイス音量(%)」×「音量数値変数値(%)」”となります。
    項目参照:変数
  • コンフィグにおいて音声の消音切替を提供したい場合には、設定項目「消音切替変数」に既存の変数名を記述します。
    指定した変数の値が「true」であれば設定音量で再生され、「false」になると消音されます。
  • ボイス0……音量0の状態で設定します。コマンド「イン」を用いて設定音量まで上げることができます。
設定項目記述の種類説明
【必須】名前命名音声素材に設定する個体名
【必須】素材ファイル名ファイル名音声素材のファイル名
音量数値変数個体名音量の調整時に用いる変数名
消音切替変数個体名音量の調整時に用いる変数名

ボイス再生(voiceReplay)

ボイス再生
  • 直近に再生したボイス素材をもう一度再生します。
  • ボタンの適用コマンドとして設定することを想定していると思われます。

背景ボイス(bgvoice)

背景ボイス backv roar.ogg mrlion fight
  • 他のボイス素材が再生される時に音量がゼロになるボイス素材を再生します。
  • コンフィグにおいてトラックバーを用いて音量を個別に調節できるようにする場合には、設定項目「音量数値変数」において既存の変数名を記述します。
    設定音量は“「既定音量」×「主音量(%)」×「ボイス音量(%)」×「音量数値変数値(%)」”となります。
    項目参照:変数
  • 背景ボイス0……音量0の状態で設定します。コマンド「イン」を用いて既定音量にすることができます。
設定項目記述の種類説明
【必須】名前命名素材に設定する個体名
【必須】素材ファイル名ファイル名音声素材のファイル名
音量数値変数個体名音量の調整時に用いる変数名
音量ゼロ対象の名前の一部個体名優先して再生されるボイス素材の個体名

自動ボイス登録(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」から自動割当が行われます。
  • コンフィグにおいてトラックバーを用いて音量を個別に調節できるようにする場合には、設定項目「音量数値変数」に既存の変数名を記述します。
    設定音量は“「既定音量」×「主音量(%)」×「ボイス音量(%)」×「音量数値変数値(%)」”となります。
    項目参照:変数
設定項目記述の種類説明
【必須】登録名命名自動割当音声に設定する個体名
【必須】素材ファイル名形式ファイル名(特殊)音声素材のファイル名形式
【必須】開始番号数値自動割当音声の連番の開始番号
音量数値変数個体名音量の調整時に用いる変数名

自動ボイス(autoVoice)

自動ボイス v_fighter fighter
  • コマンド「自動ボイス登録」で設定した自動割当音声を再生します。
    例スクリプト文のような記述を繰り返すだけで自動的に音声が割り振られるため、記述が簡略化されます。
  • このコマンドが適用されると、割当番号に合致するファイル名の音声素材が再生され、再生後に1が割当番号に加算されます。
    次回適用時には1だけ大きい割当番号に合致するファイル名の音声素材が再生されます。
    • コマンド「自動ボイス登録」の例スクリプト文のように設定したあと、上記の例スクリプト文のようにコマンドを適用すると、「fighter_0064.ogg」が再生されます。
      次に同様のコマンドを適用すると「fighter_0065.ogg」が、また次には「fighter_0066.ogg」が再生されます。連番部分が自動加算された素材が割り当てられるということです。
設定項目記述の種類説明
【必須】名前命名音声に設定する個体名
【必須】設定済登録名個体名設定済の自動割当音声の個体名

一時停止(pause)

一時停止 背景音
一時停止 "(?!vn_sysBGM)"
  • 対象の再生・変化を一時停止します。
  • Ver8.4.2以前では音声素材の再生の一時停止に限定されていましたが、Ver10.0.0より効果関連コマンドの一時停止に対応しました。
    例の2つめは、背景音以外の変化を一時停止します。
設定項目記述の種類説明
【必須】対象名個体名一時停止する対象の個体名
画面領域範囲個体名適用する対象の画面領域名

再生続行(play)

再生続行 背景音
再生続行 "(?!vn_sysBGM)"
  • 対象の一時停止を解除します。
  • Ver8.4.2以前では音声素材の一時停止の解除に限定されていましたが、Ver10.0.0より効果関連コマンドの一時停止の解除に対応しました。
    例の2つめは、背景音以外の変化の一時停止を解除します。
設定項目記述の種類説明
【必須】対象名個体名一時停止を解除する対象の個体名
画面領域範囲個体名適用する対象の画面領域名

音量(volume)

音量 背景音 50% 2000 a7
音量2 背景音 -30% 400
  • 素材の再生時の音量を変更します。
  • 音量2……音量を相対的に変化させます。例の場合は、背景音の既定音量の70%が適用後の音量になります。
  • 加速度を設定することができます。
    項目参照:加速度について
設定項目記述の種類説明
【必須】対象名個体名音量を変更する対象素材の個体名
【必須】音量数値(単位付)
または
数値(符号・単位付)
素材再生時の音量(単位:%)
または
音量の相対変化量(単位:%)
効果時間数値音量変更に要する時間(単位:ms)
加速度数値変化の種類

動画(movie)

動画 movie1 opening.mp4 0 0 50
動画 ムービー2 ending.mp4 320 180 999 カメラ付着
  • Moviesフォルダ内にある動画を再生します。
  • Ver10.0.0より、対応形式はビデオ側がMPEG1 Video ("mpeg1")、オーディオ側がMPEG1 Audio Layer II ("mp2")の.mpgファイルに限定されました
  • 画像と同様の効果コマンドを適用することができます(Ver7.6.0で対応完了)。
  • 再生が終了しても自動的に退場するわけではありませんので、必ずコマンド「アウト」を適用してください
  • 動画0……透明度と音量を0に設定します。コマンド「イン」を用いると、透明度は255、音量は主音量へと変更されます。
  • コマンド「待機」に設定できるオプションの中に「動画終了」と「干渉可能」があります。
    たとえば……
    待機 動画終了
    というコマンドを動画コマンド以降に設定すると、動画の再生が終了するまでは以降のスクリプトの読み込みをしなくなります。
    さらに……
    待機 動画終了 干渉可能
    というように「干渉可能」を付加すれば、コマンド「続行」によって待機状態を解除し、以降のスクリプトを読み込み始めることができるようになります。
    この場合においても、動画の再生が終了した時点からは以降のスクリプトを読み込み始めます。
設定項目記述の種類説明
【必須】名前命名素材に設定する個体名
【必須】素材ファイル名ファイル名動画として再生するファイル
【必須】x座標数値素材左上の頂点のx座標(左右方向の座標)
【必須】y座標数値素材左上の頂点のy座標(上下方向の座標)
【必須】表示レイヤー数値素材の位置するレイヤー
反復設定項目の語句
(反復)
反復再生の適用
カメラオプション※1カメラに対する反映方法

※1……「カメラオプション」に関しては項目参照:カメラオプションについて

背景音自動継続(bgmAutoContinue)

背景音自動継続 true
  • あるBGMの再生中にコマンド「背景音」で同一の音源を再生する場合において、先頭から再生するか、コマンドを無視して再生を続けるかのいずれかの動作を設定します。
設定項目記述の種類説明
【必須】true
または
false
設定項目の語句
(true・false)
BGMの更新回避
または
BGMの更新許可

反復区間(loopRegion)

反復区間 54000 86000
  • BGMの指定区間を反復再生します。
    例の場合は、54秒経過後から86秒までの区間が反復されます。
  • Ver12.2.0現在、エディターのコマンド目録上の設定項目と実際の設定項目とが異なっています
設定項目記述の種類説明
【必須】反復開始時点数値反復区間の開始時点(単位:ms)
【必須】反復終了時点数値反復区間の終了時点(単位:ms)

音源確認機(soundChecker)

音源確認機 rescheck01 vn_sysBGM 60000 ジャンプ roleskip
  • 対象の再生時間が設定した時間を超えた際に、特定のコマンドを実行します。
    コマンドの実行が完了すると、確認機は消去されます。
設定項目記述の種類説明
【必須】反復開始時点数値反復区間の開始時点(単位:ms)
【必須】反復時間数値反復区間の長さ(単位:ms)

同期音(syncSound)

同期音 loop01 /BGM/bgm01_05.ogg vn_sysBGM
  • 同期対象と同じ時点を再生する音声個体を設定します。
    たとえば、同期対象が1000ms時点を再生していれば、指定した音声素材の1000msが同時に再生されます。
  • 同期対象が設定項目「反復」によって最初から再生される場合には、音声素材も最初から再生されます。
  • 音声素材の再生時間は同期対象以上である必要があります。
設定項目記述の種類説明
【必須】反復開始時点数値反復区間の開始時点(単位:ms)
【必須】反復時間数値反復区間の長さ(単位:ms)

音量ログ(logAmplitude)

音量ログ true
  • コマンド「音声絵」等によって音量が取得される際に、その音量をログに記録させます。既定は「false」です。
    音量の設定値の参考に用いることが想定されています。
設定項目記述の種類説明
【必須】true
または
false
設定項目の語句
(true・false)
音量の記録
または
音量記録の省略