スクリプト関連コマンド(Ver12.8.0)

Last-modified: 2021-09-19 (日) 00:53:54


続行(continueRead)

続行
続行 効果音 proceeded.ogg
キートリガー enter 続行
  • テキスト表示中においては、表示中のテキストを、待機状態を指定する記述等のある部分まで即座に表示させます。
    待機時においては、テキストの読込みにおける待機状態を解除し、以降のスクリプトを読み込みます。
  • 文字窓での文章の読込み等、作品には必須となるコマンドです。
    文字窓を設定する前に、必ずコマンド「キートリガー」でこのコマンドを設定しておくようにしましょう
  • Ver8.0.0より、設定項目「続行時適用コマンド」が追加され、待機解除時にコマンドを適用することが可能になりました。
    設定項目記述の種類説明
続行時適用コマンドコマンド続行後に適用するコマンド

待機(wait)

待機
待機 続行禁止
待機 演出終了 spade13
  • スクリプトの読込みを一時停止させます。
  • 付与するオプションによって待機の種類や適用・解除条件が異なります。
    • オプション無し
      コマンド「続行」によって待機が解除されます。
      早送りは適用されます。
      設定項目「オプション」になにも記述しなければ、この種類になります。
    • 時間
      設定した時間だけ待機してから、以降のスクリプトの読込みを再開します。
      待機時間中はコマンド「続行」による待機解除が適用されません。
      早送りは適用されます。
      設定項目「オプション」には、待機時間の数値(単位:ms)を記述します。
    • 続行禁止
      コマンド「ジャンプ」によってのみ、以降のスクリプトの読込みが可能となります。
      早送りやボタン選択(コマンド「ジャンプ」によって以降に設置されている栞へ移動する場合を除く)では待機が解除されません。
      このオプションで適用された待機状態自体は解除されることがないと考えるのが近いです。
      設定項目「オプション」には、「続行禁止」と記述します(Ver6.2.0以前では「一般進入防止」、Ver7.6.0以前では「読み込み続行禁止」)。
    • ボタン選択
      コマンド「ボタン」で設定したボタンのうち、特定の文字列を持つものを選択することで待機が解除されます。
      また、このオプションでは早送りが一時停止します。
      設定項目「オプション」には、「ボタン選択」と記述し、半角スペースを挟んで、待機解除動作を付与するボタンの個体名の先頭の文字列を記述します。
    • メッセージ選択
      ダイアログの結果が出た時点で待機が解除されます。
      主にメッセージスクリプトにおいて用います。
      設定項目「オプション」には、「メッセージ選択」と記述します。
    • 動画終了
      動画の再生が終了するまで待機します。
      終了後には待機状態が自動で解除されます。ただし、動画はレイヤー上に残ったままになりますので、コマンド「アウト」の適用が必要となります。
      早送りは適用されます。
      設定項目「オプション」には、「動画終了」と記述します。
      • 干渉可能
        オプション「動画終了」に追加できるオプションです。
        動画の再生中にコマンド「続行」が適用されると、動画の終了を待たずに待機状態を解除します。
        設定項目「オプション」には、「動画終了 干渉可能」と記述します。
    • 文字入力完了
      使用中の文字窓にテキスト入力機能を付加し、ENTERキーの入力があるまで待機状態になります。
      早送りは一時停止します。
      設定項目「オプション」には、「文字入力完了」と記述します。
      入力したテキストは、テキスト入力に用いた文字窓の個体名をコマンド「変数」の右辺に指定することで変数としての使用が可能になります。
    • 文字出力完了
      使用中の文字窓のテキスト表示が完了するまで待機状態になります。
      文字窓が存在しない場合に設定するとエラーを出します。
      早送りは適用されます。
      設定項目「オプション」には、「文字出力完了」と記述します。
    • 演出終了
      指定した対象への効果コマンドの適用が完了するまで待機します。
      早送りは適用されます。
      設定項目「オプション」には、「演出終了」と、演出終了を検知する対象の個体名を記述します。
    • 個体消滅
      指定した対象が退場するまで待機状態になります。
      早送りでは待機が解除されません。
      設定項目「オプション」には、退場を検知する対象の個体名を記述します。
    設定項目記述の種類説明
オプション待機状態の種類や条件

※記述に関しては上記を参照

ジャンプ(jump)

ジャンプ magazine
ジャンプ system\basis.txt show1
  • コマンド設定前に読込んでいるスクリプトから、指定した栞・他スクリプト・他スクリプト内の栞へ移動します。
    栞については下項「栞」を参照してください。
  • 移動箇所と指定方法は以下のとおりです。
    • 同じスクリプト内の栞
      コマンド「待機 続行禁止」の回避などに用います。
      同じスクリプト内で予め設定してある栞へ読込み開始点を移動させたい場合、その栞の個体名のみを記述します。
      ただし、栞を参照する対象はその時点における最上位スクリプト内になることに注意が必要です。キートリガーの使用時に想定と異なるスクリプトが最上位となっているために意図しない動作やエラーの原因となることもあります。
    • 他のスクリプトの開始行
      他のスクリプトファイルを最初から読込ませたい時に用います。
      他のスクリプトのファイルを指定して、そのスクリプト内にある栞を指定しない場合は、開始行からの読込みになります。
      記述は移動先のスクリプトのファイル名になります。
    • 他スクリプト内の栞
      他のスクリプトファイル内にある栞へ読込み開始点を移動させたい場合、移動先のスクリプトのファイル名と、栞の個体名を記述します。
    • コマンド「ジャンプ」は、通常では適用したスクリプトのみを破棄してから目的スクリプトを読込みます。
      したがって、コマンド「スクリプト」を用いて呼び出されたスクリプトで、「スクリプト終了」を読込んでいないものは残ります。
      すると、場合によっては存在するスクリプトが過剰になるので、動作への支障を回避するために、コマンド「最終ジャンプ」を用いることになります。
  • 同じスクリプト間・スクリプト内移動のコマンドである「スクリプト」と異なるのは、「スクリプト終了」やスクリプト最終行への到達等があっても移動元のスクリプトに自動では戻らないという点です。
    あなた自身がゲームエンジンになり、フォルダが並ぶ机の前に座っていると想像してみてください。
    フォルダの中には、各種の素材と共にスクリプトのファイルが収められていて、そのファイルにはそれぞれにいくつかの栞が挟んであります。
    コマンド「ジャンプ」で行うのは、今まで読んでいたスクリプトのファイルをフォルダの中に戻してから、目的のスクリプトのファイルを取り出し、最初から、または栞から読んでゆく、という作業になります。
設定項目記述の種類説明
【必須】栞名
または
目的スクリプトファイル名
個体名
または
ファイル名
移動先の箇所に関する項目
目的スクリプト内の栞名個体名目的スクリプト内にある、移動箇所となる栞の個体名

最終ジャンプ(finaljump)

  • それまで読み込んでいたスクリプトをすべて破棄してから、目的のスクリプト・栞まで移動します。
    ゲーム画面からタイトル画面への移動等において用いることになるでしょう。
設定項目記述の種類説明
【必須】栞名
または
目的スクリプトファイル名
個体名
または
ファイル名
移動先の箇所に関する項目
目的スクリプト内の栞名個体名目的スクリプト内にある、移動箇所となる栞の個体名

番号スクリプトジャンプ(srcScriptJump)

  • スクリプトスタック内のスクリプトを、指定したスクリプトや栞にジャンプさせます。
    スクリプトスタック内のスクリプトの指定には、コマンド「スクリプト番号確認」で説明しているスクリプト番号を用います。
設定項目記述の種類説明
【必須】スクリプト番号数値移動対象のスクリプト番号
【必須】栞名
または
目的スクリプトファイル名
個体名
または
ファイル名
移動先の箇所に関する項目
目的スクリプト内の栞名個体名目的スクリプト内にある、移動箇所となる栞の個体名

スクリプト(script)

スクリプト system/save.txt
スクリプト system/backlog.txt show
  • コマンド設定前に読込んでいるスクリプトから、指定したスクリプト・スクリプト内の栞へと、読込むスクリプトを移動します。
    ただし、コマンド設定前に読込んでいたスクリプトは保存されます
    したがって、このコマンドで読込まれるスクリプトは既存のスクリプトの上へ順番に積み重なってゆきます
  • 指定したスクリプトにおいて、「スクリプト終了」の行まで読込む、またはスクリプトの最終行まで読込むと、コマンド設定前のスクリプトの、コマンドを設定した行まで戻り、読込みを再開します
    • コマンド「スクリプト」によって読込まれたスクリプトは、「スクリプト終了」によって読込みを終えるとスクリプトの積み上がりから抜き出されて破棄されます。
  • 同じスクリプト間・スクリプト内移動のコマンドである「ジャンプ」と異なるのは、移動先スクリプトの読込み終了後に移動元のスクリプトまで戻るという点です。
    上項で出したのと同じモデルを用いて考えましょう。
    コマンド「スクリプト」で行うのは、端的に言えば“参照”です。
    まず、今まで読んでいたスクリプトを机上に置き、別のスクリプト(同じスクリプトの場合もあります)を取り出します。
    そして、その別のスクリプト内のある部分を参照するように読込みます。
    それが終わったら別のスクリプトのほうをフォルダに戻し、机上に置いたスクリプトを再び読込み始めます。
  • コマンド「スクリプト」と変数の代入を組み合わせることで、「関数」と呼ばれる機能を用いることができます(項目参照:コマンド「スクリプト」に備わる機能「関数」を使おう)。
設定項目記述の種類説明
【必須】目的スクリプトファイル名ファイル名移動先のスクリプトのファイル名
目的スクリプト内の栞名個体名目的スクリプト内にある、移動箇所となる栞の個体名
関数の代入値関数に代入する値等

※代入に使用する値に依る。

スクリプト終了(script_fin)

スクリプト終了
  • スクリプトの読込みを終了させます。
    その後、読込んでいたスクリプトを捨て、その前に読込んでいたスクリプト(ストックの直下にあるスクリプト)に戻ります。
    戻り先のスクリプトが存在しない場合はこのコマンドを適用してもなにも起こりません。
  • スクリプトは読込んだ順に積まれてゆきます。そうして積まれたスクリプトをストックと呼びます。
    そして、特定のコマンドではストックを減らすことができ、そうすることによってコマンド「スクリプト終了」を読込んだスクリプトの下にストックが無い状態がありえます。これが「戻り先のスクリプトが存在しない場合」です。

スクリプト終了原点回帰(script_fin_return_to_main)

スクリプト終了原点回帰
  • スクリプトの読込みを終了させます。
    その後、最初に読込んでいたスクリプト(ストックの最下にあるスクリプト)に戻ります。
    戻り先のスクリプトが存在しない場合(読込みを終了させたスクリプトがストックの最下にある場合等)はこのコマンドを適用してもなにも起こりません。

キーダウン(keyDown)

キーダウン l.click 続行
キーダウン ctrl.r
  • キートリガーのうち、キーボードのキー押下やマウスのボタン押下に応じて適用するコマンドを設定できます。
    キーボード等における入力と設定項目の記述との対応は下表のとおりです。

実際の入力左クリック右クリックホイールアップホイールダウンホイールクリックENTERESCSPACE左CTRL右CTRL左SHIFT右SHIFT
コマンド上の記述l.clickr.clickwheel.upwheel.downwheel.clickenterescspacectrl.lctrl.rshift.lshift.r
実際の入力01234567890+-*/
コマンド上の記述01234567890+-*/
実際の入力F1F2F3F4F5F6F7F8F9F10F11F12
コマンド上の記述f1f2f3f4f5f6f7f8f9f10f11f12
実際の入力abcdefghijklmnopqrstuvwxyz
コマンド上の記述abcdefghijklmnopqrstuvwxyz
実際の入力矢印キー上矢印キー下矢印キー右矢印キー左
コマンド上の記述updownrightleft


  • 設定項目「適用コマンド」を記述しなければ、指定したキーのコマンド登録が解除されます。
  • ボタンクリック時には左クリック押下のキートリガーが作動しません。
設定項目記述の種類説明
【必須】対象キー名押下キートリガーを設定する対象のキー名
適用コマンドコマンド対象のキーに設定するコマンド

※上表の「コマンド上の記述」が該当します。

キーアップ(keyUp)

キーアップ l.click 続行
キーアップ ctrl.r
  • キートリガーのうち、キーボードのキー放しやマウスのボタン放しに応じて適用するコマンドを設定できます。
    キーボード等における入力と設定項目の記述との対応はコマンド「キーダウン」で挙げた表のとおりです。
  • 設定項目「適用コマンド」を記述しなければ、指定したキーのコマンド登録が解除されます。
  • ボタンクリック時には左クリック放しのキートリガーが作動しません。
設定項目記述の種類説明
【必須】対象キー名放しキートリガーを設定する対象のキー名
適用コマンドコマンド対象のキーに設定するコマンド

※上表の「コマンド上の記述」が該当します。

キー長押し(keyPress)

キー長押し right スクリプト sys_count.txt plus
キー長押し ctrl.r
  • キートリガーのうち、キーボードのキー押下やマウスのボタン押下に応じて連続適用するコマンドを設定できます。押下している間に適用しつづけられることを想定したコマンドを設定します。
    キーボード等における入力と設定項目の記述との対応はコマンド「キーダウン」で挙げた表のとおりです。
  • 設定項目「適用コマンド」を記述しなければ、指定したキーのコマンド登録が解除されます。
  • ボタンクリック時には左クリック押下のキートリガーが作動しません。
設定項目記述の種類説明
【必須】対象キー名放しキートリガーを設定する対象のキー名
適用コマンドコマンド対象のキーに設定するコマンド

※上表の「コマンド上の記述」が該当します。

キートリガー初期化(keyTriggerReset)

キートリガー初期化
  • 適用時点の画面領域に設定されているキートリガーをすべて初期化します。
    他の画面領域に設定されているキートリガーには影響しません(Ver12.4.0以前はすべてのキートリガーに影響します)。

キートリガー活性化(keyTriggersActive)

キートリガー活性化 false
  • 設定しているすべてのキートリガーの使用を再開または中止します。キートリガーを初期化せずに使用を中止することが可能です。
    キートリガーは設定と同時に使用可能となるため、キートリガー設定直後にコマンド「キートリガー活性化 true」を設定する必要はありません。
設定項目記述の種類説明
【必須】true
または
false
設定項目の語句
(true・false)
キートリガーの使用再開
または
キートリガーの使用中止

入力禁止(inputLock)

入力禁止 false
  • 適用時点の画面領域に設定されているすべてのキートリガーとUIの使用を中止または再開します。
    演出等の途中でボタン選択等によって飛ばしてしまうことを回避したい時などに用いることができます。
設定項目記述の種類説明
【必須】true
または
false
設定項目の語句
(true・false)
キートリガーとUIの使用再開
または
キートリガーの使用中止

栞(bookmark)

栞 mark01
  • コマンド「ジャンプ」「スクリプト」の目的地点を設定します。
    同じスクリプト内に同じ個体名を持つ複数の栞が存在する場合、開始行から最も近いものが選択されます。
  • コマンド「スクリプト」によって目的の栞として参照される場合において、設定項目「栞名」の後に記述される文字列は設定項目「引数名」となります。
    引数名は、以降のスクリプト文において「スクリプト終了」を記述している行を読込むまでの間において、変数と同様の代入処理を行うことができます(項目参照:コマンド「スクリプト」に備わる機能「関数」を使おう)。
設定項目記述の種類説明
【必須】栞名命名栞に設定する個体名
引数名関数に設定する関数名

マクロ(macro)

マクロ "【モブ・ボブ】" "文字 ch_name_mobbob 100 420 120 royalgothic.ttf 30 "モブ・ボブ""
マクロ "入力地点" "スクリプト system/textbox.txt inputbox"
  • スクリプトの読込み時において、コマンド行内の特定の語句を、設定する語句へと変換します。
    これによって、特定の語句を別の記述に置き換えることができるため、用法次第でスクリプトの簡略化が見込めます。
  • コマンド・テキストに関係無く変換するため、テキストに用いる語句にマクロを設定してしまわないように注意する必要があります
    Ver7.6.0より、マクロの変換対象はコマンド行に限定されました。
  • マクロを設定した語句内に含まれる語句に対して、さらにマクロを設定することはできません。
  • 設定項目「変換対象」「変換結果」のいずれにおいても正規表現を用いることができます。
    項目参照:正規表現に触れてみよう
設定項目記述の種類説明
【必須】変換対象マクロで変換する語句
【必須】変換結果変換に用いる語句

※スクリプト内で使用している語句、または正規表現による広範な指定を記述します。

コマンドマクロ(commandMacro)

コマンドマクロ "【モブ・ボブ】" "文字 ch_name_mobbob 100 420 120 royalgothic.ttf 30 "モブ・ボブ""
コマンドマクロ "入力地点" "スクリプト system/textbox.txt inputbox"
  • スクリプトの読込み時において、コマンド行の先頭にある特定の語句を、設定する語句へと変換します。
    コマンド「マクロ」の変換対象を行頭に限定することで、意図しない変換を回避しやすくしたコマンドです。
  • コマンド行の開始を表す「~」は、このコマンドにおける行頭には含まれません。
  • マクロを設定した語句内に含まれる語句に対して、さらにマクロを設定することはできません。
  • コマンド「マクロ」と異なり、設定項目「変換対象」「変換結果」のいずれにおいても正規表現を用いることができません。
設定項目記述の種類説明
【必須】変換対象テキストマクロで変換する語句
【必須】変換結果テキスト変換に用いる語句

スクリプト番号確認(checkScriptIndex)

スクリプト番号確認 1
  • コマンドを適用したスクリプトが、適用時点で積まれているスクリプトの中で何番目にあるのかを確認します。
    番号は0から始まります
  • 指定した番号とスクリプト番号とが一致すればなにも起きません。
    指定した番号とスクリプト番号とが異なればエラーを表示します。
  • このコマンドは製作者がスクリプトの動作確認のために用いるコマンドです。
    したがって、このコマンドは配布前になるべく削除しておきましょう
設定項目記述の種類説明
【必須】番号数値正しいか確認するスクリプト番号

画面領域開始(screenSpaceStart)

画面領域開始 UI_log
  • 新たな画面領域を作成し、既存の画面領域の上に階層付けます。
    以降に設定される個体は作成した画面領域に属することになります。
    項目参照:画面領域
設定項目記述の種類説明
【必須】領域名命名新たな画面領域の名前

画面領域上書き(screenSpaceOverwrite)

画面領域上書き UI_log_mid
  • 最上位の画面領域の領域名を上書きします(「vn_screen_space_main」は不可)。
    以降に設定される個体は更新された画面領域に属することになります。
  • 上書き前の画面領域に属する個体は、上書き後の画面領域に属する個体と同階層になります
    したがって、「同階層画面領域」ではいずれに属する個体も範囲に含まれることになります。
    項目参照:画面領域
設定項目記述の種類説明
【必須】領域名命名最上位の画面領域の新たな名前

画面領域終了(screenSpaceFin)

画面領域終了 UI_log
  • 指定した画面領域を破棄します。基本的には最上位の画面領域を指定します。
  • 画面領域を破棄しても属していた個体は退場しませんが、基本的には画面領域内に個体が無い状態での使用を想定しています。
    項目参照:画面領域
設定項目記述の種類説明
【必須】領域名対象名破棄する画面領域の名前

lua(lua)

lua custom_func("alice", "ice cream", "puppy")
  • 予め読込んでおいたLuaスクリプト内のコマンド・関数を使用します。
    Luaスクリプトの読込みには、コマンド「スクリプト」を用います。
  • Luaスクリプトの詳細については近日追加予定です。
設定項目記述の種類説明
【必須】Luaコマンドコマンドとして適用するLuaコマンド

※記述に関しては分類を省略します。