システム関連コマンド(Ver12.8.0)

Last-modified: 2021-09-24 (金) 18:19:54


ゲームエンド(endGame)

ゲームエンド
  • 画面を閉じ、ゲームを終了します。
    スクリプトにおいてこのコマンドが存在する行を読み込むと、即座にゲームは終了します。設定する場所には注意しましょう。

プリーロード(preLoad)

プリーロード /BGM/theme.ogg 永久
  • 指定した素材ファイルをバックグラウンド処理で読込みます。
    コマンド設定時に大容量ファイルを素材として読込むと発生しやすいタイムラグを抑制するコマンドです
    したがって、該当する素材を用いるコマンドよりもいくらか前で設定しておく必要があります。
  • このコマンドには既定フォルダが存在しないため、ファイル名の記述には全体パスを用います(Ver10.6.0以降では先頭に「/」を記述します)
    したがって、基本的には先頭にフォルダ名が用いられます。
    たとえば……
    • フォルダ「Images」内にあるファイル「img01.png」を指定する場合には、ファイル名を「/Images/img01.png」と記述します。
    • フォルダ「Movies」内にあるフォルダ「op」内にあるファイル「op1.mp4」を指定する場合には、ファイル名を「/Movies/op/op1.mp4」と記述します。
  • 動作はリアルタイムプレビューでは確認できません。テストプレイでのみ確認でき、記述に不備があって読込みができない場合にはエラーが出ます(エラー表示はVer8.0.0以降)。
  • 作品の終了まで保存しておきたい素材には、設定項目「永久」を記述します。保存先は、画像・動画素材がGPUメモリ、その他がCPUメモリです。
    保存限界に達するとクラッシュします。GPUメモリは多くの場合でCPUメモリよりも容量が小さいため、画像素材の永久指定は最低限に留めることを推奨します。
    フォントや音声素材等のCPUメモリに保存される素材が永久指定を推奨されています。
設定項目記述の種類説明
【必須】読込みファイル名ファイル名(全体)先行して読込む素材のファイル名
永久設定項目の語句素材の保存指定

未使用素材開放(releaseUnusedMemory)

未使用素材開放
  • 予期しないエラーを回避するために、使用済素材が占めているメモリ領域を開放するコマンドです。
    • メモリとは、コンピュータの一時記憶領域のことを指します。
      エンジンが素材を呼び出す度に、その素材はメモリ上に保存された上で用いられることになります。
      使用済素材が増えれば、メモリ上で占める領域が拡大することになり、動作速度が低下する他に、予期しないエラーが発生することがあります(ただし通常ならばめったに起こりません)。
      そのようなエラーを回避するために、作品への影響が無い使用済素材が占めているメモリ領域を開放するというのが、このコマンドの動作です。
  • コマンド「ロード」の適用によっても未使用素材開放が行われます。
  • 未使用素材開放(ロード時も含む)を行うかどうかは、setting.xml内のsysMemoryManagementTypeの値によって変更できます
    • 0
      未使用素材開放を行います。
    • 1
      未使用素材開放を行いません。
  • 別のアプリによってメモリ管理が厳重に行われている場合などにおいては、未使用素材開放を行うとエラーになる場合があります。
    配布後にプレイヤーからエラー報告がある場合には、setting.xml内のsysMemoryManagementTypeの値を1にするよう伝えましょう

ボイス再生形式(voicePlayType)

ボイス再生形式 1
  • コマンド「続行」適用時においてボイス素材を再生している場合の処理を設定します。
    処理を指定する数値は以下のとおりです。
    • 「0」
      ボイス再生を強制中止します。
    • 「1」
      ボイス再生を続行します。
設定項目記述の種類説明
【必須】ボイス処理数値(※)コマンド「続行」適用時に再生中のボイス素材に対する処理

※上記を参照してください。

スクリーン(screen)

スクリーン 0
  • ゲーム画面の表示サイズを変更します。
    ゲーム画面の表示サイズを指定する数値は以下のとおりです。
    • 「0」
      モニターサイズに拡大します。
      縦横比はモニターのものに従うため、既定のものから変更される場合があります。
    • 「1」
      既定のサイズに戻します。既定のサイズは「settings.xml」の「vn_win_width」「vn_win_height」に記録されています。
    • 「1 (幅) (高さ)」
      指定するサイズに変更します。指定したサイズは「settings.xml」の「vn_win_width」「vn_win_height」に保存されます。
      サイズ指定は、「1」の後に半角スペースを挟んで幅を、さらに半角スペースを挟んで高さを記述して行います。両方とも単位はピクセルです。
      サイズ指定をすると、サイズ指定をしない「1」を指定した時のサイズが変わってしまうため、サイズ指定を用いる場合には既定を含めたすべてのサイズを用意しましょう。
    • 「2」
      既定のサイズにおける縦横比を固定して、モニターサイズに拡大します。
      縦横のいずれかがモニターサイズになった時点で拡大を止め、余る領域は黒地になります。
    • 「3」
      モニターサイズに拡大し、モニターの解像度を変更します。
    • 「4」
      規定のサイズにおける縦横比を固定して、モニターサイズに拡大し、モニターの解像度を変更します。
設定項目記述の種類説明
【必須】表示サイズ数値(※)ゲーム画面の表示サイズ

※上記を参照してください。

セーブ(save)

セーブ 1 320 180
  • 指定したスロットにセーブデータを作成・上書きします。
    Ver12.4.0以前において、実際に記録されるスロット番号は「(vn_slotsPerPage)×(vn_slotPageCur)+(スロット番号)」の値になります。
  • Ver12.4.0以前において、セーブデータ上書き時にはダイアログが表示されます。
    ダイアログにおいて表示されるテキストは既定のものになります。既定のテキストはフォルダ「Config」内のファイル「Commands_jp.xml」を編集することで変更できます。
  • セーブ時にはスクリーンショットが撮影されます。スクリーンショットのサイズはこのコマンドで設定した値になります。
    セーブ時のスクリーンショットに映らないようにしたい個体がある場合には、コマンド「セーブ画像除外範囲」を適用します。
  • Ver7.6.0以前において、ボタンのコマンドとして設定すると、ボタンの通常時素材にセーブ時のスクリーンショットが用いられるようになります。
設定項目記述の種類説明
【必須】スロット番号数値セーブデータを作成・上書きするスロット番号
【必須】スクリーンショット幅数値セーブ時のスクリーンショットの表示幅
【必須】スクリーンショット高さ数値セーブ時のスクリーンショットの表示高さ

ロード(load)

ロード 2
  • 指定したスロットのセーブデータのロードを行います。
    Ver12.4.0以前において、実際にロードされるセーブデータのスロット番号は「(vn_slotsPerPage)×(vn_slotPageCur)+(スロット番号)」の値になります。
  • Ver12.4.0以前において、セーブデータロード時にはダイアログが表示されます。
    ダイアログにおいて表示されるテキストは既定のものになります。既定のテキストはフォルダ「Config」内のファイル「Commands_jp.xml」を編集することで変更できます。
  • Ver7.6.0以前において、ボタンのコマンドとして設定すると、ボタンの通常時素材にセーブ時のスクリーンショットが用いられるようになります。
設定項目記述の種類説明
【必須】スロット番号数値ロードするセーブデータのスロット番号

セーブ削除(savedelete)

セーブ削除 3
  • 指定したスロットのセーブデータを削除します。
    Ver12.4.0以前において、実際に削除されるセーブデータのスロット番号は、「(vn_slotsPerPage)×(vn_slotPageCur)+(スロット番号)」の値になります。
  • Ver12.4.0以前において、単体の場合は即座に適用されますが、ボタンのコマンドとして設定する場合にはダイアログが表示されるようになります。
    • ダイアログにおいて表示されるテキストは既定のものになります。既定のテキストはフォルダ「Config」内のファイル「Commands_jp.xml」を編集することで変更できます。
設定項目記述の種類説明
【必須】スロット番号数値削除するセーブデータのスロット番号

クイックセーブ(quickSave)

クイックセーブ 160 90
  • クイックセーブ機能を適用します。
    このコマンドで作成されるセーブデータのスロット番号は0となります。
設定項目記述の種類説明
【必須】スクリーンショット幅数値セーブ時のスクリーンショットの表示幅
【必須】スクリーンショット高さ数値セーブ時のスクリーンショットの表示高さ

クイックロード(quickLoad)

クイックロード
  • コマンド「クイックセーブ」によってセーブデータが作成されている場合において、クイックロード機能を適用します。
    セーブデータが存在しない場合は次行からスクリプトの読込みを再開します。

セーブ情報継承(waitSaveDataFetch)

セーブ情報継承 0 60
  • このコマンドを作品開始直後に適用させることで、ブラウザ版でのセーブデータの継承が可能となります。
    ブラウザ出力専用のコマンドですが、Windows版で記述をしていても問題はありません。
  • 継承するセーブデータはスロット番号の最小値と最大値とで指定します。
    通常は、最小値に0、最大値に「vn_slotsPerPage」×「vn_slotPageMax」の値を指定します。
設定項目記述の種類説明
【必須】スロット番号最小数値継承するセーブデータのスロット番号の最小値
【必須】スロット番号最大数値継承するセーブデータのスロット番号の最大値

スクリーンショット(screenshot)

スクリーンショット
  • ゲーム画面のスクリーンショットを撮影し、フォルダ「Screenshots」に保存します。

セーブ除外範囲(noSaveRange)

セーブ除外範囲 slot.*
  • セーブデータに保存しない個体を個体名で指定します。Ver7.6.0以前における、個体名の先頭への「~」の付与と同様の指定を行うコマンドです。
    指定した個体は、セーブデータに保存されず、スクリーンショット上にも表れません。
  • 指定する個体名には基本的に正規表現を用います(項目参照:正規表現に触れてみよう)。
設定項目記述の種類説明
【必須】除外対象個体名セーブ対象から除外する個体の個体名

セーブ画像除外範囲(noSaveSSRange)

セーブ画像除外範囲 menu.*
  • セーブデータ記録時のスクリーンショットに保存しない個体を個体名で指定します。Ver7.6.0以前における、個体名の先頭への「^」の付与と同様の指定を行うコマンドです。
    指定した個体は、セーブデータ自体には保存されますが、スクリーンショット上には表れません。
  • 指定する個体名には基本的に正規表現を用います(項目参照:正規表現に触れてみよう)。
設定項目記述の種類説明
【必須】除外対象個体名セーブデータ記録時のスクリーンショットから除外する個体の個体名

コマンド未該当時報告(errorOnNoCommandMatch)

コマンド未該当時報告 true
  • スクリプトにコマンドではない行がある場合にエラーを出すかどうかを設定します。
    「true」では、エラーを出すように設定します。「false」では、エラーを出さずに無視するよう設定します。
設定項目記述の種類説明
【必須】true
または
false
設定項目の語句
(true・false)
コマンド不一致の報告
または
コマンド不一致の無視

描画許可(allowRender)

描画許可 true
  • 新たな描画をするかどうかを設定します。既定は「true」です。
    「false」にした場合でも、既存の画面表示は維持されます。
設定項目記述の種類説明
【必須】true
または
false
設定項目の語句
(true・false)
コマンド不一致の報告
または
コマンド不一致の無視

開く(open)

開く Images/gift.png
開く http://lightvn.net
  • フォルダ内のファイル、または外部ページを開きます。
    ゲームエンジン外に影響があるコマンドであり、注意が必要です。
  • ファイル名の記述には全体パスを用います
  • ファイル「settings.xml」の項目「disallowOpen」がtrueの場合には、項目「Msg_disallowOpen」のテキストがダイアログメッセージとして表示される。
設定項目記述の種類説明
【必須】開示ファイル名
または
開示URL名
ファイル名(全体)
または
URL
開くファイル名・URL

マウスカーソル(mouseCursor)

マウスカーソル cursor.gif
  • 作品内で用いるマウスカーソルの画像素材を変更します。
    デフォルトのものに戻したい場合には、設定項目「マウスカーソル素材ファイル名」に「none」と記述します。
設定項目記述の種類説明
【必須】マウスカーソル素材ファイル名ファイル名マウスカーソルに用いる画像素材のファイル名

ダイアログスクリプト登録(setDialogScript)

ダイアログスクリプト登録 dialog.txt
  • ダイアログに用いるスクリプトを指定します。
    Ver10.0.0以前においてはエディターの設定項目でしたが、Ver10.2.0よりコマンドとなりました。
  • コマンド「バックログ設定」やキートリガーへのコマンド「続行」の設定と同様に、作品起動直後に適用されるようにしましょう。
設定項目記述の種類説明
【必須】ダイアログスクリプトファイル名ファイル名ダイアログ用スクリプトのファイル名

ダイアログ(dialog)

ダイアログ "これでいいのですか?" ジャンプ sure
  • 「ノベル設定」の「メッセージスクリプト」に設定したスクリプトを読込み、ダイアログを表示します。
  • 設定したダイアログテキストは、変数「vn_msg_str」に代入されます。
設定項目記述の種類説明
【必須】ダイアログテキストテキストダイアログにおいて表示するテキスト
【必須】yes選択時コマンドコマンドコマンド「ダイアログ結果 yes」適用時に適用されるコマンド

ダイアログ結果(dialogResult)

ダイアログ結果 yes
  • ダイアログに対する返答を設定します。
    主にボタンのコマンドとして設定され、コマンド「待機 メッセージ選択」による待機状態はこのコマンドの適用によって解除されます。
設定項目記述の種類説明
【必須】yes
または
no
設定項目の語句
(yes・no)
ダイアログへの返答

砂時計(timer)

砂時計 timer01 2000 反復 スクリプト effect.txt zoom
  • 設定した時間が経過した時点でコマンドを適用します。
  • 設定項目「反復」を設定すると、設定した時間が経過する度にコマンドを適用します。
    反復適用を解消するには、コマンド「アウト」で砂時計名を対象名に指定します。
  • 適用コマンドを「"」で囲むと、コマンド適用毎に変数代入等が再計算されるようになります。
    適用コマンドを変数変化に対応させたい場合などに有効です。
設定項目記述の種類説明
【必須】砂時計名命名砂時計に設定する個体名
【必須】設定時間数値コマンド適用までの時間(単位:ms)
反復設定項目の語句
(反復)
繰り返し適用の有無
【必須】適用コマンドコマンド設定時間経過後に適用するコマンド

クリア(clear)

クリア
  • 画面上に存在するすべての個体を抹消します。
  • コマンド「アウト 全部」と異なり、バックログ用の文字窓個体等の非活性個体も抹消するため注意が必要です。

クリア色(clearRGB)

クリア色 255 255 255
クリア色 #f0f0f0
  • 背景色を設定します。
    背景色は背景未設定時において画面上に表示されます。
  • 背景色の指定にはRGB(10進数)またはHEX(16進数)という、2種類のカラーコードのいずれかを用います。
    • RGBを使用する場合は、0~255の数値を3つ指定します。左から順に、光の三原色である赤・緑・青を表しています。
    • HEXを使用する場合は、先頭に「#」を置いてから、6桁の英数字を指定します。#を除いて、左から2桁ずつがRGBと同様の三原色に対応しています。
設定項目記述の種類説明
【必須】RGBカラーコード
または
HEXカラーコード
数値背景色のカラーコード

個体深度計算(objectDepthTest)

個体深度計算 true
  • 画像個体の描画において深度(カメラからの距離)を正確に計算するかどうかを設定します。
    「true」では正確な深度計算を行いますが、同じ深度の大きな面が複数重なっている場合には描画が不安定になることがあります。
    「false」では深度計算にいくらかの省略が含まれ、現実とは異なる表示となることがありますが、描画は安定します。
設定項目記述の種類説明
【必須】true
または
false
設定項目の語句
(true・false)
正確な深度計算の使用
または
省略した深度計算の使用

イベント(event)

イベント load 前 スクリプト system\basis.txt fo_pl
  • 指定した処理の実行前後に別のコマンドを適用させるよう設定します。
    例の場合には、コマンド「ロード」を適用する際に、「スクリプト system\basis.txt fo_pl」「ロード」の順番で適用されます。
  • 設定項目「イベント」で設定するイベント名は以下のとおりです(Ver12.4.0以前は「ロード(load)」のみ)。
    • load
      ロード処理を指します。
    • close_signal
      ウィンドウ右上の閉じるボタンの押下を指します。
    • disallow_open
      コマンド「開く」が禁止されている場合における試行時を指します。
    • disallow_popup
      ポップアップが禁止されている場合におけるエラー等のポップアップ表示試行時を指します。
  • イベントの前後から適用コマンドを削除したい場合には、設定項目「追加コマンド」になにも記述せずにこのコマンドを適用します。
設定項目記述の種類説明
【必須】イベント前後にコマンドを追加するコマンド
【必須】
または
設定項目の語句
(前・後)
イベントに対するコマンドの追加位置
追加コマンドコマンドイベント前後に適用するコマンド

※……上記イベント名を記述する。

タイトル追加文字列(setTitleSuffix)

タイトル追加文字列 "After"
  • 作品タイトルの末尾に指定した文字列を追加します。追加した文字列はウィンドウに表示されます。
    章名を追加する等の用途があると思われます。
設定項目記述の種類説明
【必須】追加テキストテキスト作品タイトルの末尾に追加するテキスト

システムメッセージ(SystemMessage)

システムメッセージ "お知らせです"
  • システムメッセージとして、設定したテキストを表示します。
    luaスクリプト内での使用を想定しているものと思われます。
設定項目記述の種類説明
【必須】メッセージテキストシステムメッセージとして表示するテキスト

システムエラ(SystemError)

システムエラ "深刻かもしれないエラーが発生しました"
  • エラーが発生したことを明示するために、設定したテキストを表示し、エディターのテストプレイ中であればテストプレイを終了するかどうかのダイアログを表示します。
    luaスクリプト内での使用を想定しているものと思われます。
設定項目記述の種類説明
【必須】メッセージテキストエラーの発生を警告するテキスト

システムログ(SystemLog)

システムログ "第4章開始"
  • 指定したテキストをシステムログに記録します。ログ内の区切りを見やすくすることができます。
設定項目記述の種類説明
【必須】ログテキストテキストシステムログに記録するテキスト

仮絵生成(createDummyCG)

仮絵生成 ch_dm_man01 namelabel.ttf 200 500 男01 黙 腕組み 寄り眉
  • 立ち絵の仮素材を作成します。仮素材はpng形式で保存されます。
  • 設定項目「名前ラベル」に記述したテキストは胸部に表示されます。
    設定項目「表情ラベル」に記述したテキストは頭部に表示されます。
    設定項目「他ラベル」に記述したテキストは名前ラベルの下にやや小さく表示されてゆきます。
設定項目記述の種類説明
【必須】保存ファイル名命名作成した仮素材の画像ファイルに設定するファイル名
【必須】ラベル用フォント名ファイル名ラベルに用いるフォントのファイル名
【必須】数値仮素材の幅
【必須】高さ数値仮素材の高さ
【必須】名前ラベルテキスト胸部にラベル表示するテキスト
表情ラベルテキスト頭部にラベル表示するテキスト
他ラベルテキスト追加でラベル表示するテキスト(複数可)

合成画像登録(textureCreate)

合成画像登録 newman canvas.png add01.png 20 20 add02.png 20 80
  • 複数の画像を重ねて、その結果として完成する画像を新たな1枚の画像として登録します。
    合成した画像はフォルダ「Images」内の画像として扱われ、画像素材を用いるコマンドにおいて合成画像の個体名を指定すれば用いることができます。
  • 合成素材の設定項目を記述することで、キャンバス画像領域上に別の画像を追加してゆきます。
    合成素材は追加順で奥から手前へと重ねられます。素材の座標はキャンバス左上頂点からの相対座標で設定します。
    また、合成素材の領域がキャンバス画像領域(透明領域も含む)から出る場合には、その領域は合成されずに削除されます。
  • 合成素材の個数に制限はありませんが、多くなるほど画像生成に時間がかかります。
設定項目記述の種類説明
【必須】登録名命名合成画像に設定する個体名
【必須】キャンバスファイル名ファイル名合成画像の最背面に位置する画像のファイル名
【必須】合成素材ファイル名ファイル名キャンバスの画像領域上に合成する画像のファイル名
【必須】合成素材相対x座標数値キャンバスの画像領域上に合成する画像の相対x座標(左右方向の座標)
【必須】合成素材相対y座標数値キャンバスの画像領域上に合成する画像の相対y座標(上下方向の座標)
追加合成素材ファイル名ファイル名キャンバスの画像領域上に合成する画像のファイル名
追加合成素材相対x座標数値キャンバスの画像領域上に合成する画像の相対x座標(左右方向の座標)
追加合成素材相対y座標数値キャンバスの画像領域上に合成する画像の相対y座標(上下方向の座標)

※合成素材追加時には当該3項目を揃えて追加すること。