コマンド一覧 - HANON-games/Shiden GitHub Wiki

このページでは Shiden のコマンドについて解説します。

Text コマンド

メッセージウィンドウにテキストを表示するコマンドです。テキストには { 変数名 } で変数の値を入れられます。変数名の中に : が含まれる場合 \: のようにエスケープしてください。変数のプレフィックスは以下の通りです。

{ System::変数名 } SystemVariable
{ Local::変数名 } LocalVariable
{ Predefined::変数名 } PredefinedSystemVariable

Voiceのトラック ID は 0 になります。 <wait time="1.0"/> のように記述すると次の文字を表示するまでにウェイトを入れることができます。また、< > などの特殊文字を使用することができます。

パラメータ名	詳細
テキストウィジェット名	テキストを表示するテキストウィジェット名を指定します。
テキストタイプ	テキストのタイプを指定します。このタイプによって表示する枠を切り替えます。
テキスト	表示するテキストを指定します。
入力待ちをする	テキストを表示後、入力待ちをします。
即全文を表示	テキストを即座に表示します。
ボイス	テキストと同時に再生するボイスを指定します。
音声のトラックID	ボイスのトラックIDを指定します。
ポポポ音	ポポポ音を指定します。
ボイスの自動停止無効化	セリフ送りまたはボイス再生時に前のボイスを止める設定が有効な場合でも、前のボイス再生を止めないようにします。ボイスを重ねたいときなどに使用します。
前の文章に続ける	有効の場合、指定されたスロットに既に表示されている内容に付け足す形で表示します。
言語2	2つ目の言語で表示するテキスト
言語3	3つ目の言語で表示するテキスト
言語4	4つ目の言語で表示するテキスト
言語5	5つ目の言語で表示するテキスト
言語6	6つ目の言語で表示するテキスト
言語7	7つ目の言語で表示するテキスト
言語8	8つ目の言語で表示するテキスト
言語9	9つ目の言語で表示するテキスト
言語10	10個目の言語で表示するテキスト

Image コマンド

画像を表示するコマンドです。画像が指定されていない場合、Position、Size、SizeToContent の値は無視され、現在の画像をフェードアウトします。ステップは関数が Step の時のみ使用します。ブレンド係数は関数が Ease の時のみ使用します。マテリアルから作成した SlateBrush の場合、フェードが効かないため透明度は別途変更してください。

パラメータ名	詳細
スロット名	画像を表示するスロットを指定します。
画像	表示する画像を指定します。指定されていない場合フェードアウトになります。
位置を上書きする	画像を表示する際の位置を上書きします。
サイズを上書きする	画像を表示する際のサイズを上書きします。
SizeToContentを上書きする	画像を表示する際のSizeToContentの設定を上書きします。
フェード関数	フェードの仕方を指定します。
フェード秒数	フェードの秒数を指定します。
ステップ	フェードの種類が Step の時のみ有効です。
ブレンド係数	フェードの種類が Ease の時のみ有効です。
終了待ちをする	アニメーションが完了するまで次のコマンドに進まないようにします。

Sound コマンド

音源を再生するコマンドです。 Sound には以下の3種類があります。なお、このコマンドで指定する SoundWave や SoundCue には適切なサウンドクラスを指定する必要があります。例えばデフォルト設定の場合、BGM に設定する SoundWave あるいは SoundCue には SC_ShidenBGM を指定する必要があります。

名前	機能
BGM	トラックIDを分けて複数同時に再生できる。トラックIDを指定して停止できる。
SE	トラックIDは無効。いくつでも複数同時に再生できる。停止することが出来ない。
Voice	トラックIDを分けて複数同時に再生できる。トラックIDを指定して停止できる。セリフ送りをした際に前の音声が停止する(設定で変更可能)。

音源の欄を空にすると停止できます。ボイスの自動停止無効化の値はVoiceのみ有効です。 MetaSound Sourceの場合、Start Timeの値は反映されないようです。

パラメータ名	詳細
音源の種類	音源の種類を選択します。
トラックID	再生するトラックIDを指定します。既にそのトラックIDで音源が再生されていた場合は、それまで再生されていた音源が停止されます。なお、SEではこの項目は無効です。
音源	再生する音源を指定します。空の場合、現在そのトラックIDで鳴っている音源を停止します。
ボリューム	音源の再生ボリュームを指定します。
ピッチ	音源のピッチを指定します。
開始時間	音源の開始位置をしています。
フェードの種類	フェードインまたはフェードアウトを選択します。
フェード関数	フェードの仕方を指定します。
フェード秒数	フェードの秒数を指定します。
ボイスの自動停止無効化	Voiceの場合のみ有効です。セリフ送りまたはボイス再生時に前のボイスを止める設定が有効な場合でも、前のボイス再生を止めないようにします。ボイスを重ねたいときなどに使用します。
フェードの終了待ちをする	フェードの終了待ちを行います。
サウンドの終了待ちをする	サウンドの終了待ちを行います。なお、指定した SoundCue がループする設定になっている場合はエラーとなります。

AdjustBGMVolume コマンド

再生中のBGMの音量を変更するコマンドです。

パラメータ名	詳細
トラックID	対象のBGMのトラックIDを指定します。
ボリューム	音源の再生ボリュームを指定します。
フェード関数	フェードの仕方を指定します。
フェード秒数	フェードの秒数を指定します。
終了待ちをする	音量変更の終了待ちを行います。

Options コマンド

選択肢を表示するコマンドです。

パラメータ名	詳細
選択肢1	選択肢1に表示する内容です。
選択肢2	選択肢2に表示する内容です。
選択肢3	選択肢3に表示する内容です。
選択肢4	選択肢4に表示する内容です。
選択肢5	選択肢5に表示する内容です。
代入先変数の種類	選択結果を格納する変数の種類を指定します。
代入先変数名	選択結果を格納する変数の名前を指定します。選択肢を選んだあと、この変数に選んだ選択肢に応じて、0～4の数値が代入されます。
テキストレイヤーを隠す	選択肢を表示している間、テキストレイヤーを非表示にします。

TextInput コマンド

プレイヤーに文字入力をさせるコマンドです。入力可能な文字の正規表現では、例えば次のように指定できます。

数字のみ許可: [0-9]
abcのみ許可: [abc]
数字以外を許可: [^0-9]

パラメータ名	詳細
最大長	入力できる最大文字数を指定します。指定していない場合は無制限です。
最大行数	入力できる最大行数を指定します。指定しない場合は無制限です。
入力可能な文字の正規表現	入力可能な文字を正規表現で指定します。
デフォルトテキスト	入力枠に最初から入力されている内容です。
ヒントテキスト	入力枠が空の時に表示されるヒントの内容です。
代入先変数の種類	入力結果を格納する変数の種類を指定します。
代入先変数名	入力結果を格納する変数の名前を指定します。
テキストレイヤーを隠す	入力枠を表示している間、テキストレイヤーを非表示にします。

AssignVariable コマンド

変数に値を代入するコマンドです。

パラメータ名	詳細
変数の種類	値を代入する変数の種類を指定します。
変数名	値を代入する変数の名前を指定します。
値	代入する値を指定します。

Calculation コマンド

変数の値を用いて演算をするコマンドです。値の型は指定する変数の型と揃える必要があります。

たとえば、

変数名 number (型はInteger)
オペレータ +=
値 1

を指定すると、number の数を現在の値から 1 増やすことが出来ます。

パラメータ名	詳細
変数の種類	変更をする変数の種類を指定します。
変数名	変更をする変数の名前を指定します。計算結果はここで指定した変数に入ります。
オペレータ	演算のオペレータを指定します。
値	演算に使用する値を指定します。

If コマンド

分岐を行うコマンドです。条件が満たされる場合のみ If コマンドの後に入力されたコマンドに進みます。必ず EndIf コマンドとセットで使用してください。

以下が分岐の実装例です。

パラメータ名	詳細
変数の種類	判定に使用する変数の種類を指定します。
変数名	判定に使用する変数の名前を指定します。
オペレータ	条件式のオペレータを指定します。
右辺の値	条件式の右辺の値を指定します。

ElseIf コマンド

分岐を行うコマンドです。 If コマンドの判定が false だった場合に通るコマンドです。

パラメータ名	詳細
変数の種類	判定に使用する変数の種類を指定します。
変数名	判定に使用する変数の名前を指定します。
オペレータ	条件式のオペレータを指定します。
右辺の値	条件式の右辺の値を指定します。

Else コマンド

分岐を行うコマンドです。このコマンドよりも上に入力された分岐がすべて false の場合に通ります。

EndIf コマンド

分岐の終了を表すコマンドです。

LoopWhile コマンド

条件を満たしている間、LoopWhile ～ EndLoopWhile 間を無限ループするコマンドです。

パラメータ名	詳細
変数の種類	変更をする変数の種類を指定します。
変数名	変更をする変数の名前を指定します。計算結果はここで指定した変数に入ります。
オペレータ	演算のオペレータを指定します。
右辺の値	演算に使用する値を指定します。

EndLoopWhile コマンド

ループ範囲の終了を表すコマンドです。

Tag コマンド

タグを表すコマンドです。 Jump コマンドとあわせて使用します。

パラメータ名	詳細
名前	タグ名を指定します。同じシナリオで同じタグ名を2度使わないようにしてください。

Jump コマンド

タグ名を指定してジャンプを行うコマンドです。

パラメータ名	詳細
ジャンプ先のタグ名	ジャンプ先のタグ名を指定します。

EndScenario コマンド

現在再生しているシナリオやマクロを修了するコマンドです。マクロの中では次のシナリオ指定は無視され、元のシナリオの続きから再開します。

パラメータ名	詳細
次のシナリオ	次に再生するシナリオを指定します。マクロの中で呼ばれた場合は無視されます。

Break コマンド

現在再生しているシナリオを中断するコマンドです。 ShidenActorSampleを使用している場合は中断理由に ReturnToTitle と入力するとタイトルに戻ることができます。

パラメータ名	詳細
中断理由	中断する理由を入力します。

Comment コマンド

コメント用のコマンドです。実際の処理に影響を与えることはありません。

パラメータ名	詳細
コメント	コメントを入力します。

WidgetAnimation コマンド

Shiden Widget に定義されたアニメーションを再生するコマンドです。

パラメータ名	詳細
アニメーション名	アニメーション名を指定します。
開始時間	アニメーションの開始位置を指定します。
ループ再生回数	ループ再生する回数を指定します。
再生モード	再生モードを指定します。
再生速度	再生速度を指定します。
状態を復元	状態を復元するかどうかを指定します。
終了待ちをする	アニメーションが完了するまで次のコマンドに進まないようにします。

Delay コマンド

指定した時間だけ待機するコマンドです。

パラメータ名	詳細
秒数	待機する時間を指定します。

CallWidgetFunction コマンド

Shiden Widget に定義された関数を呼び出すコマンドです。

パラメータ名	詳細
関数名	関数名を指定します。
引数1	引数1を指定します。
引数2	引数2を指定します。
引数3	引数3を指定します。
引数4	引数4を指定します。
引数5	引数5を指定します。
引数6	引数6を指定します。
引数7	引数7を指定します。
引数8	引数8を指定します。
引数9	引数9を指定します。
引数10	引数10を指定します。

Fade コマンド

画面をフェードインまたはフェードアウトするコマンドです。 Z-orderの値が大きいほど前面になります。 0より大きい: 画像より前 50より大きい:テキストより前 100より大きい:ムービーより前 150より大きい:メニューより前

パラメータ名	詳細
レイヤー名	フェードを行うレイヤー名を指定します。
フェードの種類	フェードインまたはフェードアウトを選択します。
フェード秒数	フェードの秒数を指定します。
フェード関数	フェードの仕方を指定します。
ターゲット色	フェードのターゲット色を指定します。
ステップ	フェードの種類が Step の時のみ有効です。
ブレンド係数	フェードの種類が Ease の時のみ有効です。
終了待ちをする	フェードが完了するまで次のコマンドに進まないようにします。
ZOrder	フェードのZOrderを指定します。

ChangeVisibility コマンド

指定したWidgetの表示状態を変更するコマンドです。

パラメータ名	詳細
名前	対象のWidgetの名前を指定します。
可視性	変更後のVisibilityを指定します。

MoveCanvasPanelSlot コマンド

CanvasPanelSlotの位置を変更するコマンドです。

パラメータ名	詳細
スロット名	スロット名を指定します。
イージング関数	移動の仕方を指定します。
秒数	移動の秒数を指定します。
変更タイプ	絶対座標を指定するか、現在位置からの相対座標を指定するかを指定します。
位置を上書きする	位置を上書きするかどうかを指定します。
サイズを上書きする	サイズを上書きするかどうかを指定します。
ZOrderを上書きする	ZOrderを上書きするかどうかを指定します。
ステップ	移動の種類が Step の時のみ有効です。
ブレンド係数	移動の種類が Ease の時のみ有効です。
終了待ちをする	アニメーションが完了するまで次のコマンドに進まないようにします。

AutoSave コマンド

自動セーブを行うコマンドです。

パラメータ名	詳細
スロット名	セーブスロットを指定します。
サムネイルを上書きする	指定している場合は指定した画像をサムネイルとして扱います。指定していない場合はスクリーンショットがサムネイルに適用されます。

Random コマンド

乱数を変数に代入するコマンドです。

パラメータ名	詳細
変数の種類	値を代入する変数の種類を指定します。
代入先変数名	値を代入する変数の名前を指定します。
最小値	乱数の最小値を指定します。
最大値	乱数の最大値を指定します。

WaitClick コマンド

入力待ちを行うコマンドです。

パラメータ名	詳細
スキップ可否	このコマンドをスキップボタンでスキップできるかどうかを指定します。

WaitUntil コマンド

指定した条件が満たされるまで待機するコマンドです。

パラメータ名	詳細
変数の種類	判定に使用する変数の種類を指定します。
変数名	判定に使用する変数の名前を指定します。
オペレータ	条件式のオペレータを指定します。
右辺の値	条件式の右辺の値を指定します。

ForceFeedback コマンド

コントローラやスマートフォンを振動させるコマンドです。

パラメータ名	詳細
フィードバックエフェクト	再生するフィードバックエフェクトを指定します。

PlayMedia コマンド

メディアを再生するコマンドです。 MediaSourceのPlayerはElectraPlayerの利用を推奨。 ZOrderの値が大きいほど前面になります。 0より大きい: 画像より前 50より大きい:テキストより前 150より大きい:メニューより前

パラメータ名	詳細
メディアソース	再生するメディアソースを指定します。
ポーズメニューを開けるかどうか	再生中にポーズメニューを開けるかどうかを指定します。
メディアのZOrder	メディアのZOrderを指定します。

ChangeMaterialScalarParameter コマンド

Image または Retainer Box のマテリアルの Scalar parameter を操作します。

パラメータ名	詳細
ターゲット	Image または Retainer Box を指定します。
ターゲット名	Image または Retainer Box の名前を指定します。
パラメータ名	マテリアルに含まれているパラメータ名を指定します。
イージング関数	イージング関数を指定します。
秒数	変更にかかる秒数を指定します。
変更タイプ	絶対値を指定するか、現在値からの相対値を指定するかを指定します。
変更後の値	変更後の値を指定します。
ステップ	イージング関数が Step の時のみ有効です。
ブレンド係数	イージング関数が Ease の時のみ有効です。
終了待ちをする	アニメーションが完了するまで次のコマンドに進まないようにします。

ChangeMaterialTextureParameter コマンド

Image または Retainer Box のマテリアルの Texture parameter を操作します。

パラメータ名	詳細
ターゲット	Image または Retainer Box を指定します。
ターゲット名	Image または Retainer Box の名前を指定します。
パラメータ名	マテリアルに含まれているパラメータ名を指定します。
テクスチャ	変更後のテクスチャを指定します。

RunMacro コマンド

マクロを実行するコマンドです。指定したマクロに引数がある場合はそれらも設定できます。

パラメータ名	詳細
マクロ名	実行するマクロ名を指定します。

RunMacroAsParallel コマンド

マクロを並列実行 (厳密には並行実行) するコマンドです。指定したマクロに引数がある場合はそれらも設定できます。

パラメータ名	詳細
新しいプロセス名	新しいプロセス名を指定します。Defaultは指定できません。
マクロ名	実行するマクロ名を指定します。

StopParallelProcess コマンド

並列実行しているプロセスを停止するコマンドです。不具合の原因になる可能性があるため、終了待ちは true にすることを推奨します。

パラメータ名	詳細
プロセス名	停止するプロセス名を指定します。
理由	停止する理由を指定します。
停止タイミング	停止するタイミングを指定します。
終了待ちをする	対象プロセスが終了するまで次のコマンドに進まないようにします。

Print コマンド

ログに文字列を出力するコマンドです。

パラメータ名	詳細
内容	出力する内容を指定します。