- 続行(continueRead)
- 待機(wait)
- ジャンプ(jump)
- 最終ジャンプ(finaljump)
- 番号スクリプトジャンプ(srcScriptJump)
- スクリプト(script)
- 並列スクリプト(parallel_script)
- スクリプト終了(script_fin)
- 下位スクリプト一時停止(pauseLowerScript)
- スクリプト読み込み方式(scriptReadType)
- 禁止スクリプト追加(scriptPrevent)
- 禁止スクリプト解除(scriptAllow)
- 禁止スクリプト全解除(scriptAllowAll)
- スクリプト終了原点回帰(script_fin_return_to_main)
- キーダウン(keyDown)
- キーアップ(keyUp)
- キー長押し(keyPress)
- キートリガー初期化(keyTriggerReset)
- 入力禁止(inputLock)
- 栞(bookmark)
- マクロ(macro)
- コマンドマクロ(commandMacro)
- 文字マクロ(stringMacro)
- マクロ反映(macroApply)
- スクリプト番号確認(checkScriptIndex)
- 画面領域開始(screenSpaceStart)
- 画面領域上書き(screenSpaceOverwrite)
- 画面領域終了(screenSpaceFin)
- lua(lua)
- 状態更新機(stateLoop)
- 状態(state)
続行(continueRead)
続行 続行 効果音 proceeded.ogg キートリガー enter 続行
- テキスト表示中においては、表示中のテキストを、待機状態を指定する記述等のある部分まで即座に表示させます。
待機時においては、テキストの読込みにおける待機状態を解除し、以降のスクリプトを読み込みます。 - 文字窓での文章の読込み等、作品には必須となるコマンドです。
文字窓を設定する前に、必ずコマンド「キートリガー」でこのコマンドを設定しておくようにしましょう。 - Ver8.0.0より、設定項目「続行時適用コマンド」が追加され、待機解除時にコマンドを適用することが可能になりました。
指定したコマンドは、スタックの最上位のスクリプトで待機を解除する場合に適用されます。
設定項目 | 記述の種類 | 説明 | |
続行時適用コマンド | コマンド | 続行後に適用するコマンド |
待機(wait)
待機 待機 続行禁止 待機 演出終了 spade13
- スクリプトの読込みを一時停止させます。
- 付与するオプションによって待機の種類や適用・解除条件が異なります。
- オプション無し
コマンド「続行」によって待機が解除されます。
早送りは適用されます。
設定項目「オプション」になにも記述しなければ、この種類になります。 - 時間
設定した時間だけ待機してから、以降のスクリプトの読込みを再開します。
待機時間中はコマンド「続行」による待機解除が適用されません。
早送りは適用されます。
設定項目「オプション」には、待機時間の数値(単位:ms)を記述します。 - 続行禁止
コマンド「ジャンプ」によってのみ、以降のスクリプトの読込みが可能となります。
早送りやボタン選択(コマンド「ジャンプ」によって以降に設置されている栞へ移動する場合を除く)では待機が解除されません。
このオプションで適用された待機状態自体は解除されることがないと考えるのが近いです。
設定項目「オプション」には、「続行禁止」と記述します(Ver6.2.0以前では「一般進入防止」、Ver7.6.0以前では「読み込み続行禁止」)。 - ボタン選択
コマンド「ボタン」で設定したボタンのうち、特定の文字列を持つものを選択することで待機が解除されます。
また、このオプションでは早送りが一時停止します。
設定項目「オプション」には、「ボタン選択」と記述し、半角スペースを挟んで、待機解除動作を付与するボタンの個体名の先頭の文字列を記述します。 - メッセージ選択
ダイアログの結果が出た時点で待機が解除されます。
主にメッセージスクリプトにおいて用います。
設定項目「オプション」には、「メッセージ選択」と記述します。 - 動画終了
動画の再生が終了するまで待機します。
終了後には待機状態が自動で解除されます。ただし、動画はレイヤー上に残ったままになりますので、コマンド「アウト」の適用が必要となります。
早送りは適用されます。
設定項目「オプション」には、「動画終了」と記述します。- 干渉可能
オプション「動画終了」に追加できるオプションです。
動画の再生中にコマンド「続行」が適用されると、動画の終了を待たずに待機状態を解除します。
設定項目「オプション」には、「動画終了 干渉可能」と記述します。
- 干渉可能
- 文字入力完了
使用中の文字窓にテキスト入力機能を付加し、ENTERキーの入力があるまで待機状態になります。
早送りは一時停止します。
設定項目「オプション」には、「文字入力完了」と記述します。
入力したテキストは、LVN関数「lvText」を代入することで使用可能になります。
(項目参照:lvText) - 文字出力完了
使用中の文字窓のテキスト表示が完了するまで待機状態になります。
文字窓が存在しない場合に設定するとエラーを出します。
早送りは適用されます。
設定項目「オプション」には、「文字出力完了」と記述します。 - 演出終了
指定した対象への効果コマンドの適用が完了するまで待機します。
早送りは適用されます。
設定項目「オプション」には、「演出終了」と、演出終了を検知する対象の個体名を記述します。
Ver12.12.0より、無限ループの効果コマンドは待機対象から除外されます。 - 個体消滅
指定した対象が退場するまで待機状態になります。
早送りでは待機が解除されません。
設定項目「オプション」には、退場を検知する対象の個体名を記述します。 - 状態更新
コマンド「状態」によって状態が更新されるのを待機します。 - アニメ終了
指定した個体がアニメ個体を素材としていれば、当該アニメの終了まで待機します。
設定項目「オプション」には、アニメ終了を検知する対象の個体名を記述します。
- オプション無し
設定項目 | 記述の種類 | 説明 | |
オプション | ※ | 待機状態の種類や条件 |
※記述に関しては上記を参照
ジャンプ(jump)
ジャンプ magazine ジャンプ system\basis.txt show1
- コマンド設定前に読込んでいるスクリプトから、指定した栞・他スクリプト・他スクリプト内の栞へ移動します。
栞については下項「栞」を参照してください。 - 移動箇所と指定方法は以下のとおりです。
- 同じスクリプト内の栞
コマンド「待機 続行禁止」の回避などに用います。
同じスクリプト内で予め設定してある栞へ読込み開始点を移動させたい場合、その栞の個体名のみを記述します。
ただし、栞を参照する対象はその時点における最上位スクリプト内になることに注意が必要です。キートリガーの使用時に想定と異なるスクリプトが最上位となっているために意図しない動作やエラーの原因となることもあります。 - 他のスクリプトの開始行
他のスクリプトファイルを最初から読込ませたい時に用います。
他のスクリプトのファイルを指定して、そのスクリプト内にある栞を指定しない場合は、開始行からの読込みになります。
記述は移動先のスクリプトのファイル名になります。
Ver13.6.5以降においては、移動元スクリプトに属する通常変数が初期化されます。
また、Ver14.2.1以降においては、マクロ反映設定が初期化され、True状態になります。 - 他スクリプト内の栞
他のスクリプトファイル内にある栞へ読込み開始点を移動させたい場合、移動先のスクリプトのファイル名と、栞の個体名を記述します。
Ver13.6.5以降においては、移動元スクリプトに属する通常変数が初期化されます。
また、Ver14.2.1以降においては、マクロ反映設定が初期化され、True状態になります。 - コマンド「ジャンプ」は、通常では適用したスクリプトのみを破棄してから目的スクリプトを読込みます。
したがって、コマンド「スクリプト」を用いて呼び出されたスクリプトで、「スクリプト終了」を読込んでいないものは残ります。
すると、場合によっては存在するスクリプトが過剰になるので、動作への支障を回避するために、コマンド「最終ジャンプ」を用いることになります。
- 同じスクリプト内の栞
- 同じスクリプト間・スクリプト内移動のコマンドである「スクリプト」と異なるのは、「スクリプト終了」やスクリプト最終行への到達等があっても移動元のスクリプトに自動では戻らないという点です。
あなた自身がゲームエンジンになり、フォルダが並ぶ机の前に座っていると想像してみてください。
フォルダの中には、各種の素材と共にスクリプトのファイルが収められていて、そのファイルにはそれぞれにいくつかの栞が挟んであります。
コマンド「ジャンプ」で行うのは、今まで読んでいたスクリプトのファイルをフォルダの中に戻してから、目的のスクリプトのファイルを取り出し、最初から、または栞から読んでゆく、という作業になります。 - Ver13.2.0より、コマンド「スクリプト」と同様の引数指定によって「関数」と呼ばれる機能を用いることができます(項目参照:「関数」を使おう)。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 栞名 | 個体名 | 移動先の栞名 |
関数の代入値 | ※ | 関数に代入する値等 |
※代入に使用する値に依る。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 目的スクリプト | ファイル名 または 「現在」 | 移動先のスクリプトのファイル名 または 現在スクリプトを指定 |
栞名 | 個体名 | 目的スクリプト内にある、移動箇所となる栞の個体名 | |
関数の代入値 | ※ | 関数に代入する値等 |
※代入に使用する値に依る。
最終ジャンプ(finaljump)
- それまで読み込んでいたスクリプトをすべて破棄してから、目的のスクリプト・栞まで移動します。
ゲーム画面からタイトル画面への移動等において用いることになるでしょう。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 栞名 | 個体名 | 移動先の栞名 |
関数の代入値 | ※ | 関数に代入する値等 |
※代入に使用する値に依る。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 目的スクリプト | ファイル名 または 「現在」 | 移動先のスクリプトのファイル名 または 現在スクリプトを指定 |
栞名 | 個体名 | 目的スクリプト内にある、移動箇所となる栞の個体名 | |
関数の代入値 | ※ | 関数に代入する値等 |
※代入に使用する値に依る。
番号スクリプトジャンプ(srcScriptJump)
- スクリプトスタック内のスクリプトを、指定したスクリプトや栞にジャンプさせます。
スクリプトスタック内のスクリプトの指定には、コマンド「スクリプト番号確認」で説明しているスクリプト番号を用います。
設定項目 | 記述の種類 | 説明 | |
【必須】 | スクリプト番号 | 数値 | 移動対象のスクリプト番号 |
栞名 | 個体名 | 移動先の栞名 | |
関数の代入値 | ※ | 関数に代入する値等 |
※代入に使用する値に依る。
スクリプト(script)
スクリプト system/save.txt スクリプト system/backlog.txt show スクリプト 現在 anker
- コマンド設定前に読込んでいるスクリプトから、指定したスクリプト・スクリプト内の栞へと、読込むスクリプトを移動します。
ただし、コマンド設定前に読込んでいたスクリプトは保存されます。
したがって、このコマンドで読込まれるスクリプトは既存のスクリプトの上へ順番に積み重なってゆきます。 - 指定したスクリプトにおいて、「スクリプト終了」の行まで読込む、またはスクリプトの最終行まで読込むと、コマンド設定前のスクリプトの、コマンドを設定した行まで戻り、読込みを再開します。
- コマンド「スクリプト」によって読込まれたスクリプトは、「スクリプト終了」によって読込みを終えるとスクリプトの積み上がりから抜き出されて破棄されます。
- Ver14.0.2より、目的スクリプトファイル名に「現在」と記述すれば、コマンドを適用したスクリプトファイル自身を指定することができます。
- 同じスクリプト間・スクリプト内移動のコマンドである「ジャンプ」と異なるのは、移動先スクリプトの読込み終了後に移動元のスクリプトまで戻るという点です。
上項で出したのと同じモデルを用いて考えましょう。
コマンド「スクリプト」で行うのは、端的に言えば“参照”です。
まず、今まで読んでいたスクリプトを机上に置き、別のスクリプト(同じスクリプトの場合もあります)を取り出します。
そして、その別のスクリプト内のある部分を参照するように読込みます。
それが終わったら別のスクリプトのほうをフォルダに戻し、机上に置いたスクリプトを再び読込み始めます。 - コマンド「スクリプト」と変数の代入を組み合わせることで、「関数」と呼ばれる機能を用いることができます(項目参照:「関数」を使おう)。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 目的スクリプト | ファイル名 または 「現在」 | 移動先のスクリプトのファイル名 または 現在スクリプトを指定 |
目的スクリプト内の栞名 | 個体名 | 目的スクリプト内にある、移動箇所となる栞の個体名 | |
関数の代入値 | ※ | 関数に代入する値等 |
※代入に使用する値に依る。
並列スクリプト(parallel_script)
並列スクリプト system/effect.txt snow
- 指定したスクリプトをスクリプトスタックに追加し、他のスクリプトと並行して読込みます。
- コマンド「スクリプト」でのスクリプト読込みとは、以下の点が異なります。
- コマンド「並列スクリプト」を適用したスクリプトは、並列スクリプトの終了を待機しません。
したがって、並列スクリプトの読込みと元スクリプトの読込みは並行することになります。 - 並列スクリプトは1フレーム毎に1行を読込みます。
したがって、1フレームの処理としたい複数コマンドは「|」による併記を行う必要があります。
- コマンド「並列スクリプト」を適用したスクリプトは、並列スクリプトの終了を待機しません。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 目的スクリプトファイル名 | ファイル名 | 読込むスクリプトのファイル名 |
目的スクリプト内の栞名 | 個体名 | 目的スクリプト内にある、読込み開始箇所となる栞の個体名 | |
関数の代入値 | ※ | 関数に代入する値等 |
※代入に使用する値に依る。
スクリプト終了(script_fin)
スクリプト終了
- スクリプトの読込みを終了させます。
その後、読込んでいたスクリプトを捨て、その前に読込んでいたスクリプト(スタックの直下にあるスクリプト)に戻ります。 - 「LightApp」では、スタックの最下位のスクリプトにおいて当コマンドを適用することができません。
下位スクリプト一時停止(pauseLowerScript)
下位スクリプト一時停止 false
- スタックで下位に位置するスクリプト群の読込みを一時停止します。
並列スクリプト等で上位スクリプトの処理を待たせたい場合に用いることが想定されます。 - 当コマンドを適用したスクリプトがスタックから抹消されれば、停止は解除されます。
設定項目 | 記述の種類 | 説明 | |
【必須】 | true または false | 設定項目の語句 (true・false) | 下位スクリプトの読込みの一時停止 または 下位スクリプトの読込みの再開 |
スクリプト読み込み方式(scriptReadType)
スクリプト読み込み方式 1
- 素材のデータ読み込みの途中でも描画を開始できるようにするかを選択します。既定は「0」です。
- 「スクリプト読み込み方式 0」……データ読み込み途中の描画を許可します。
- 「スクリプト読み込み方式 1」……データ読み込み途中の描画を許可しません。
- 将来的にすべて「0」で動作する予定であり、このコマンドは移行のための臨時措置とのことですので、使用は極力控えましょう。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 読み込み方式 | 数値 | 読み込み方式の番号 |
禁止スクリプト追加(scriptPrevent)
禁止スクリプト追加 /Scripts/sys_
- 指定したファイルパスを持つファイルをコマンド「スクリプト」で参照することを禁止します。
ファイルパスは全体パスで指定するため、基本的には「/Scripts/」から指定を始めることになります。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 読み込み禁止ファイルパス先頭 | ※ | スクリプト参照を禁止する全体パスのファイル名の一部 |
※……ファイル名の一部を全体パスで指定
禁止スクリプト解除(scriptAllow)
禁止スクリプト解除 /Scripts/sys_
- 指定したファイルパスを持つファイルをコマンド「スクリプト」で参照することを許可します。
ファイルパスは全体パスで指定するため、基本的には「/Scripts/」から指定を始めることになります。 - 指定したファイルパスがコマンド「禁止スクリプト追加」で参照禁止にされていない場合にはエラーとなります。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 読み込み禁止ファイルパス先頭 | ※ | スクリプト参照を禁止する全体パスのファイル名の一部 |
※……ファイル名の一部を全体パスで指定
禁止スクリプト全解除(scriptAllowAll)
禁止スクリプト全解除
- コマンド「禁止スクリプト追加」で設定した参照禁止をすべて解除します。
スクリプト終了原点回帰(script_fin_return_to_main)
スクリプト終了原点回帰
- スクリプトの読込みを終了させます。
その後、最初に読込んでいたスクリプト(ストックの最下にあるスクリプト)に戻ります。
戻り先のスクリプトが存在しない場合(読込みを終了させたスクリプトがストックの最下にある場合等)はこのコマンドを適用してもなにも起こりません。 - 画面領域に対しては、Ver12.10.0以降においては開始時に設定項目「原点回帰時解除」を設定されていない画面領域まで戻ります。
キーダウン(keyDown)
キーダウン l.click 続行 キーダウン ctrl.r
- キートリガーのうち、キーボードのキー押下やマウスのボタン押下に応じて適用するコマンドを設定できます。
キーボード等における入力と設定項目の記述との対応は下表のとおりです。
実際の入力 | 左クリック | 右クリック | ホイールアップ | ホイールダウン | ホイールクリック | ENTER | ESC | SPACE | 左CTRL | 右CTRL | 左SHIFT | 右SHIFT |
---|---|---|---|---|---|---|---|---|---|---|---|---|
コマンド上の記述 | l.click | r.click | wheel.up | wheel.down | wheel.click | enter | esc | space | ctrl.l | ctrl.r | shift.l | shift.r |
実際の入力 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 |
---|---|---|---|---|---|---|---|---|---|---|---|
コマンド上の記述 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 |
実際の入力 | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 |
---|---|---|---|---|---|---|---|---|---|---|---|---|
コマンド上の記述 | f1 | f2 | f3 | f4 | f5 | f6 | f7 | f8 | f9 | f10 | f11 | f12 |
実際の入力 | a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | q | r | s | t | u | v | w | x | y | z |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
コマンド上の記述 | a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p | q | r | s | t | u | v | w | x | y | z |
実際の入力 | 矢印キー上 | 矢印キー下 | 矢印キー右 | 矢印キー左 |
---|---|---|---|---|
コマンド上の記述 | up | down | right | left |
- 設定項目「適用コマンド」を記述しなければ、指定したキーのコマンド登録が解除されます。
- ボタンクリック時には左クリック押下のキートリガーが作動しません。
- 記号のうち、「+」は反応せず、「-」「/」はキーボード側のみ反応し、「*」はテンキー側のみ反応します。
- Ver12.12.0より、NUMENTERはENTERと同一のキーとして処理されます。
- Ver14.4.0において、コマンド先頭への「.」の付与によるシンクロコマンドが適用できないよう仕様が変更されました。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 対象キー名 | ※ | 押下キートリガーを設定する対象のキー名 |
適用コマンド | コマンド | 対象のキーに設定するコマンド |
※上表の「コマンド上の記述」が該当します。
キーアップ(keyUp)
キーアップ l.click 続行 キーアップ ctrl.r
- キートリガーのうち、キーボードのキー放しやマウスのボタン放しに応じて適用するコマンドを設定できます。
キーボード等における入力と設定項目の記述との対応はコマンド「キーダウン」で挙げた表のとおりです。 - 設定項目「適用コマンド」を記述しなければ、指定したキーのコマンド登録が解除されます。
- ボタンクリック時には左クリック放しのキートリガーが作動しません。
- Ver12.12.0より、NUMENTERはENTERと同一のキーとして処理されます。
- Ver14.4.0において、コマンド先頭への「.」の付与によるシンクロコマンドが適用できないよう仕様が変更されました。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 対象キー名 | ※ | 放しキートリガーを設定する対象のキー名 |
適用コマンド | コマンド | 対象のキーに設定するコマンド |
※上表の「コマンド上の記述」が該当します。
キー長押し(keyPress)
キー長押し right スクリプト sys_count.txt plus キー長押し ctrl.r
- キートリガーのうち、キーボードのキー押下やマウスのボタン押下に応じて連続適用するコマンドを設定できます。押下している間に適用しつづけられることを想定したコマンドを設定します。
キーボード等における入力と設定項目の記述との対応はコマンド「キーダウン」で挙げた表のとおりです。 - 設定項目「適用コマンド」を記述しなければ、指定したキーのコマンド登録が解除されます。
- ボタンクリック時には左クリック押下のキートリガーが作動しません。
- Ver12.12.0より、NUMENTERはENTERと同一のキーとして処理されます。
- Ver14.4.0において、コマンド先頭への「.」の付与によるシンクロコマンドが適用できないよう仕様が変更されました。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 対象キー名 | ※ | 放しキートリガーを設定する対象のキー名 |
適用コマンド | コマンド | 対象のキーに設定するコマンド |
※上表の「コマンド上の記述」が該当します。
キートリガー初期化(keyTriggerReset)
キートリガー初期化
- 適用時点の画面領域に設定されているキートリガーをすべて初期化します。
他の画面領域に設定されているキートリガーには影響しません(Ver12.4.0以前はすべてのキートリガーに影響します)。
入力禁止(inputLock)
入力禁止 false
- 適用時点の画面領域に設定されているすべてのキートリガーとUIの使用を中止または再開します。
演出等の途中でボタン選択等によって飛ばしてしまうことを回避したい時などに用いることができます。 - Ver14.0.2より、ロード後は入力禁止状態がtrueとなる仕様が追加されました。
したがって、ロード後はコマンド「イベント」等によって適切な時機に入力禁止状態をfalseへ切り換える必要があります。 - Ver14.4.0より、Windowsにおいてウィンドウの閉じるボタンも入力に含むようになりました。
したがって、true状態下ではダイアログが表示されません。
設定項目 | 記述の種類 | 説明 | |
【必須】 | true または false | 設定項目の語句 (true・false) | キートリガーとUIの使用再開 または キートリガーと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"
- スクリプトの読込み時において、コマンド行の先頭にある特定の語句を、設定する語句へと変換します。
コマンド「マクロ」の変換対象を行頭に限定することで、意図しない変換を回避しやすくしたコマンドです。 - コマンド行の開始を表す「~」は、このコマンドにおける行頭には含まれません。
- マクロを設定した語句内に含まれる語句に対して、さらにマクロを設定することはできません。
- コマンド「マクロ」と異なり、設定項目「変換対象」「変換結果」のいずれにおいても正規表現を用いることができません。
- Ver13.6.0より、設定したコマンドマクロはコマンドと同様にオートコンプリートの対象として登録されます。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 変換対象 | テキスト | マクロで変換する語句 |
【必須】 | 変換結果 | テキスト | 変換に用いる語句 |
文字マクロ(stringMacro)
文字マクロ "主人公名" "アレクサンダー"
- スクリプトの読込み時において、テキスト内の特定の語句を、設定する語句へと変換します。
- マクロを設定した語句内に含まれる語句に対して、さらにマクロを設定することはできません。
- 設定項目「変換対象」「変換結果」のいずれにおいても正規表現を用いることができます。
項目参照:正規表現に触れてみよう
設定項目 | 記述の種類 | 説明 | |
【必須】 | 変換対象 | テキスト | マクロで変換する語句 |
【必須】 | 変換結果 | テキスト | 変換に用いる語句 |
マクロ反映(macroApply)
マクロ反映 false
- マクロによる変換の適用を切り換えます。
設定項目 | 記述の種類 | 説明 | |
【必須】 | true または false | 設定項目の語句 (true・false) | マクロの適用 または マクロの無視 |
スクリプト番号確認(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スクリプトの読込みには、コマンド「スクリプト」を用います。 - Ver14.4.0より、「{{}}」での変数名の囲みによって変数を引数として渡すことができるようになりました。
このコマンドでは「lua」以降がすべてLuaの記述として扱われるため、これ以外でLight.vnのスクリプト上からは変数を渡すことができません。 - Ver16.7.0より、Luaの処理をシンクロ処理(処理完了待機の対象に含める)にすることが可能です。
- Luaスクリプトの詳細については近日追加予定です。
設定項目 | 記述の種類 | 説明 | |
【必須】 | Luaコマンド | ※ | コマンドとして適用するLuaコマンド |
※記述に関しては分類を省略します。
状態更新機(stateLoop)
状態更新機 target1 "shot.txt" "bullet_" "beam"
- 指定した対象の対象名に「_loop」を付加した状態更新機個体を子個体として生成し、指定した並列スクリプトを適当な時機に適用します。
少なくともコマンド「状態」による状態の更新が行われた際にはスクリプトの適用が行われます。 - 指定したスクリプトで読込むのは「栞先頭」の末尾に「状態」を付加した栞以降となります。
- 指定したスクリプトが実行中である場合には、読込みが回避されます。
- Ver16.0.0以降において、適用スクリプトは状態更新機個体の属する画面領域が最上位である場合においてのみ適用されます。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 対象名 | 個体名 | 状態更新機を付与する対象の個体名 |
【必須】 | 適用スクリプト | ファイル名(テキスト) | 状態更新機の作動時に適用するスクリプト |
【必須】 | 栞先頭 | テキスト | 状態更新機の作動時に読込む栞名の先頭 |
【必須】 | 開始状態 | テキスト | 状態更新機の生成時に設定する、栞名の末尾の文字列 |
状態(state)
状態 target1 laser
- 指定した個体の状態を、指定したものに更新します。
この更新の後、状態更新機によるスクリプトの適用が行われます。
設定項目 | 記述の種類 | 説明 | |
【必須】 | 対象名 | 個体名 | 状態を更新する対象の個体名 |
【必須】 | 状態 | ※ | 対象の状態として指定する文字列 |
※栞名の末尾に付与する、任意の文字列。