コマンド一覧

このエントリーをはてなブックマークに追加
はてなブックマーク - コマンド一覧
LINEで送る

宴のコマンド早見表。
太字は入力必須
入力必須ではない項目が空欄の場合、個々にデフォルト値が割り当てられます。詳細は、各コマンド名のリンク先を参照。

テキスト・キャラクター表示早見表

宴はビジュアルノベルを作りやすくするために、Commnad列は空欄にして「キャラクター名＋表示パターン＋テキスト」という形が基本になっている。

説明 Arg1 Arg2 Arg3 Arg4 Arg5 Arg6 Text PageCtrl Voice
テキスト表示 表示テキスト ページ制御
セリフ表示 名前 表示テキスト ページ制御 ボイスファイル
キャラ表示 キャラ名 パターン レイヤー名 X座標 Y座標 ﾌｪｰﾄﾞ秒 表示テキスト ページ制御 ボイスファイル

テキストの詳細な使い方や、タグの使い方

テキスト表示の詳細
テキストタグ

高度なキャラクター表示

3Dキャラの表示
キャラクターの名前表示
着替え、性別変更などキャラクター表示をゲーム中に変更する

オブジェクト表示コマンドの一覧

Command 説明 Arg1 Arg2 Arg3 Arg4 Arg5 Arg6
未記入（キャラ表示) キャラクター表示のみをする キャラ名 パターン レイヤー名 X座標 Y座標 ﾌｪｰﾄﾞ秒
CharacterOff 指定キャラクターを非表示にする。 ・キャラクター名
・レイヤー名
・空欄で全キャラを非表示		 ﾌｪｰﾄﾞ秒
Bg 背景を表示する
イベントCG表示モードを解除		 テクスチャラベル レイヤー名 X座標 Y座標 ﾌｪｰﾄﾞ秒
BgOff 背景を非表示にする ﾌｪｰﾄﾞ秒
BgEvent イベントCGを表示する。
イベントCG表示モードとなり、
自動的にキャラクター表示はOFFになる。		 テクスチャラベル イベントCGモードのオンオフ レイヤー名 X座標 Y座標 ﾌｪｰﾄﾞ秒
BgEventOff イベントCGを非表示にする。
イベントCG表示モードが
解除されるわけではない。		 ﾌｪｰﾄﾞ秒
Sprite スプライトを表示する スプライト名 テクスチャラベル レイヤー名 X座標 Y座標 ﾌｪｰﾄﾞ秒
SpriteOff スプライトを非表示にする。 ・スプライト名
・レイヤー名
・「AllSpriteObjects」
・空欄で全スプライトを非表示		 ﾌｪｰﾄﾞ秒
Particle パーティクルを表示する パーティクル名 パーティクルラベル レイヤー名 X座標 Y座標
ParticleOff パーティクルを非表示にする ・パーティクル名
・レイヤー名
・空欄で全パーティクル非表示		 ・「Clear」即座に消す
・「StopEmitting」発生停止
・空欄でﾃﾞﾌｫﾙﾄ設定に従う
LayerOff 指定のレイヤー上に表示されているオブジェクトを
すべて非表示にする		 レイヤー名 ﾌｪｰﾄﾞ秒
LayerReset 指定のレイヤーを初期状態にする
Tweenコマンドなどで変化したレイヤーを
元の位置に戻したりする		 レイヤー名
または「All」
ChangeLayer 指定のオブジェクトのレイヤーを変更する オブジェクト名 ・「KeepGlobal」グローバル座標を保持
・「KeepLocal」ローカル座標を保持
・「ResetLocal」ローカル座標をリセット		 レイヤー名 ﾌｪｰﾄﾞ秒

サウンド系コマンドの一覧

Command 説明 Arg1 Arg2 Arg3 Arg4 Arg5 Arg6 Voice
Se SEを鳴らす SEラベル ループのTRUE/FALSE 音量
0~1で指定
StopSe SEを止める SEラベル ﾌｪｰﾄﾞ秒
Bgm BGMを鳴らす BGMラベル ループのTRUE/FALSE 音量
0~1で指定		 前の曲をﾌｪｰﾄﾞｱｳﾄする秒数 ﾌｪｰﾄﾞｲﾝ秒数
StopBgm BGMを止める ﾌｪｰﾄﾞ秒
Ambience 環境音を鳴らす 環境音ラベル ループのTRUE/FALSE 音量
0~1で指定		 前の曲をﾌｪｰﾄﾞｱｳﾄする秒数 ﾌｪｰﾄﾞｲﾝ秒数
StopAmbience 環境音を止める ﾌｪｰﾄﾞ秒
Voice ボイスを鳴らす キャラクターラベル ループのTRUE/FALSE 音量
0~1で指定		 ﾎﾞｲｽﾌｧｲﾙ名
StopVoice ボイスを止める
StopSound サウンドを止める サウンドの種類を
Bgm,Se,Ambience,Voice,Allから指定
カンマ区切りで複数指定可
空欄でBgm,Ambience		 ﾌｪｰﾄﾞ秒
ChangeSoundVolume 音量を変更する サウンドの種類を
Bgm,Se,Ambience,Voice,Allから指定
カンマ区切りで複数指定可
 音量
0~1を指定		 ﾌｪｰﾄﾞ秒

演出系コマンドの一覧

Command 説明 Arg1 Arg2 Arg3 Arg4 Arg5 Arg6 WaitType
Wait 指定時間待機する 待機秒数
WaitInput 入力があるまで待機する 入力待ちを解除する秒数
WaitCustom カスタム待機処理
プログラムから解除するまで待機
WaitConditional 指定した条件式がTRUEの間待機を続ける 条件式 最低待機秒数
WaitFadeObjects オブジェクトのフェードの終了を待つ 対象
カンマ区切りで複数入力可		 ウェイトタイプ
WaitEffectTime 指定時間待機する。
ウェイトタイプが設定できるため、エフェクトスキップ等と組み合わせ可能。		 待機秒数 ウェイトタイプ
WaitSound 指定のサウンドが鳴り終わるまで待機する。 サウンドのタイプ
Bgm、Ambience、Voice、Seのいずれかを指定		 対象のサウンドの名前 ウェイトタイプ
SkipEffect 継続中のエフェクトをすべてスキップし終了 スキップ対象のタイプ
FadeIn 画面全体を覆うカラーフェードイン フェードカラー カメラの名前 ルール画像名 境界線ﾌｪｰﾄﾞ値 ﾌｪｰﾄﾞ秒
またはｱﾆﾒ名		 ウェイトタイプ
FadeOut 画面全体をカラーフェードアウト フェードカラー カメラの名前 ルール画像名 境界線ﾌｪｰﾄﾞ値 ﾌｪｰﾄﾞ秒
またはｱﾆﾒ名		 ウェイトタイプ
Shake 画面やキャラクターを揺らす 揺らす対象の名前 パラメーター Version2までは
ウェイトタイプ		 ウェイトタイプ
Tween 表示オブジェクトを
Tweenアニメーションさせる		 Tween対象の名前 タイプ パラメーター easeType loopType Version2までは
ウェイトタイプ		 ウェイトタイプ
PlayAnimation キーフレームアニメーションを再生 アニメーション対象の名前 アニメーション名 セーブ有効かのTRUE/FALSE ウェイトタイプ
SetPivot Pivotを設定 Pivotを設定するオブジェクト名 PivotのX値。
0~1.0fを設定
Left,Center,Rightのキーワードでも可		 PivotのY値。
0~1.0fを設定
Bottom,Center,Topのキーワードでも可		 ピボット値をずらすX値
空欄の場合0		 ピボット値をずらすY値
空欄の場合0		 ピボットタイプ
ResetPivot Pivotを初期値に戻す 対象のオブジェクト名
RuleFadeIn ルール画像付きフェードイン オブジェクト名 ルール画像名 境界線のフェード値 ﾌｪｰﾄﾞ秒
またはｱﾆﾒ名		 ウェイトタイプ
RuleFadeOut ルール画像付きフェードアウト オブジェクト名 ルール画像名 境界線のフェード値 ﾌｪｰﾄﾞ秒
またはｱﾆﾒ名		 ウェイトタイプ
CaptureImage 今の画面をキャプチャし
キャプチャ画像を表示する		 作成するオブジェクト名 キャプチャ画像を撮るカメラ名 レイヤー名
ImageEffect 指定したカメラに
イメージエフェクトをかける		 カメラ名 イメージエフェクト名 アニメーション名 ﾌｪｰﾄﾞ秒 ウェイトタイプ
ImageEffectOff 指定したカメラの
イメージエフェクトを解除する		 カメラ名 イメージエフェクト名
または「All」		 アニメーション名 ﾌｪｰﾄﾞ秒 ウェイトタイプ
ZoomCamera 指定したカメラを
ズームアニメーションする		 カメラ名 ズーム値 カメラの中心X カメラの中心Y ｱﾆﾒｰｼｮﾝ時間 ウェイトタイプ
Vibrate モバイルデバイスの
バイブレーションを作動させる
Movie ムービーを再生する
Unity2018.2以降では廃止		 ムービーファイル名 ループのTRUE/FALSE スキップが可能かのTRUE/FALSE
Video 動画（Unity5.6のVideoPlayer）の再生 動画ファイル名 カメラ名 ループのTRUE/FALSE スキップが可能かのTRUE/FALSE
Thread 指定した演出スレッドを呼び出す 演出スレッドのシナリオラベル
WaitThread 指定した演出スレッドの終了待ちをする スレッドのシナリオラベル キャンセル可能かのTRUE/FALSE

UI系コマンドの一覧

Command 説明 Arg1 Arg2 Arg3 Arg4 Arg5 Arg6
GuiActive GUIのアクティブ状態をオン、オフする。 GUIのオブジェクト名 アクティブのOn、Off
GuiPosition GUIの位置を変える GUIのオブジェクト名 X座標 Y座標
GuiSize GUIのサイズを変える GUIのオブジェクト名 横サイズ 縦サイズ
GuiReset GUIを初期状態にリセットする。 GUIのオブジェクト名
ShowMessageWindow メッセージウィンドを表示する
HideMessageWindow メッセージウィンドを非表示にする
InitMessageWindow 複数のメッセージウィンドウを使う場合に使用します ウインドウ名その1 その2 その3 その4 その5 その6
ChangeMessageWindow 使用するメッセージウィンドウを切り替えます メッセージウインドウ名
ShowMenuButton メニューボタンを表示にする
HideMenuButton メニューボタンを非表示にする

ロジック、分岐コマンドの一覧

Command 説明 Arg1 Arg2 Arg3 Arg4 Arg5 Arg6
Param フラグなどのパラメーターの計算 計算式
Jump 指定のシナリオラベルにジャンプ ジャンプ先のシナリオラベル 条件式
JumpRandom ランダムにジャンプ（自動分岐）します。 ジャンプ先のシナリオラベル 条件式 確率の高さ
Selection 選択肢を表示 ジャンプ先のシナリオラベル 条件式 選択された場合
行う計算式		 使用するプレハブ名 X座標 Y座標
SelectionClick 表示オブジェクトを選択肢にする ジャンプ先のシナリオラベル 条件式 選択された場合
行う計算		 オブジェクト名
If If文を開始 if判定の論理式
ElseIf ElseIf文を開始 if判定の論理式
Else Else文を開始
EndIf If文終了
JumpSubroutine サブルーチン処理の呼び出し ジャンプ先サブルーチンラベル 条件式 サブルーチン終了後のジャンプ先ラベル
JumpSubroutineRandom JumpRandomのサブルーチン版 ジャンプ先サブルーチンラベル 条件式 サブルーチン終了後のジャンプ先ラベル 確率の高さ
EndSubroutine サブルーチンの終了

終了宣言コマンドの一覧

Command 説明 Arg1 Arg2 Arg3 Arg4 Arg5 Arg6
EndPage ページ末尾の宣言
EndSceneGallery 回想シーンの終了の区切りを通知する
EndScenario シナリオを終了
PauseScenario シナリオを一時停止

拡張系コマンドの一覧

Command 説明 Arg1 Arg2 Arg3 Arg4 Arg5 Arg6
SendMessage あらかじめ設定された
AdvEngine外のオブジェクトに
SendMessageをする
簡易的な拡張機能のためのもの		 識別のための名前 任意 任意 任意 任意 任意
SendMessageByName シーン内の任意のオブジェクトに
SendMessageをする
手軽に使える拡張機能のためのもの		 GameObject名 呼び出すメソッド名 任意 任意 任意 任意
BroadcastMessageByName 指定の名前のGameObjectに
BroadcastMessageする		 GameObject名 呼び出すメソッド名 ・「Default」全シーンのGameObjectが検索対象
・「UtageObject」宴のオブジェクトのみが検索対象
・「RenderTexture」宴のテクスチャ書き込みオブジェクトが検索対象		 任意 任意 任意

マクロ

Macroシート内にマクロを定義することで、「複数のコマンドを組み合わせた新しいコマンド」を作って使うこともできます。
詳細はこちらを

その他

コメントの記述の仕方などは、エクセルシートの記述の詳細を参照してください