コンテンツにスキップ

コマンドリファレンス

コマンドは、Argodeビジュアルノベルスクリプトのコアとなる構成要素です。これらは、キャラクターの表示、背景の変更、サウンドの再生、ユーザーインターフェースの制御など、ArgodeSystemに特定のアクションを実行させるための命令です。

一般的なコマンド構文

ほとんどのコマンドはシンプルな構文に従います。

command_name [位置引数1] [位置引数2] ... [キーワード引数1=値1] [キーワード引数2="値2"]
  • command_name: コマンドの名前(例: showscenewaitui)。
  • 位置引数: その順序に基づいてコマンドに渡される値。これらは通常、最も一般的または主要なパラメータに使用されます。
  • キーワード引数: キー=値で指定されるパラメータ。これらはオプションであり、任意の順序で指定できます。

例:

# 位置引数
show alice happy at center

# キーワード引数
show alice expression=happy position=center

# 混合引数
show alice happy at center with fade duration=1.0

コマンドの種類

Argodeは主に2種類のコマンドをサポートしています。

ビルトインコマンド

これらはArgodeフレームワークにバンドルされているコマンドです。一般的なビジュアルノベルタスクに不可欠な機能を提供します。包括的なリストと詳細な使用法については、ビルトインコマンドリファレンスを参照してください。

例:

wait 2.5
ui show "res://ui/main_menu.tscn"
set_array inventory ["剣", "ポーション"]

カスタムコマンド

カスタムコマンドを使用すると、ゲームの特定のニーズに合わせて独自のコマンドを作成することで、Argodeの機能を拡張できます。これらはGodotスクリプトとして実装され、Argodeによって自動的に検出されます。

独自のカスタムコマンドの作成方法については、カスタムコマンド概要を参照してください。

例:

# カスタムの'shake_screen'コマンドを作成したと仮定
shake_screen intensity=5.0 duration=0.5

# カスタムの'add_item'コマンドを作成したと仮定
add_item "魔法の剣" quantity=1

一般的なコマンドカテゴリ

コマンドの完全なリストはビルトインコマンドリファレンスにありますが、ここではよく遭遇するカテゴリをいくつか紹介します。

  • ダイアログとキャラクター制御: ダイアログの表示、キャラクターの表示/非表示、表情や位置の管理を行うコマンド。
    • 例: showhidescenecharacter(定義用)
  • フロー制御: 物語の進行、分岐、サブルーチンを管理するコマンド。
    • 例: jumpcallreturnmenu
  • UI制御: カスタムUIシーンの表示、非表示、管理を行うコマンド。
    • 例: uishowcallfreeなどのサブコマンドを含む)
  • 変数管理: ゲーム変数を設定および操作するコマンド。
    • 例: setset_arrayset_dict
  • タイミング: スクリプトの実行を一時停止するコマンド。
    • 例: wait
  • オーディオ: 背景音楽と効果音を再生するコマンド。
    • 例: play_musicstop_musicplay_sound

この概要は、Argodeにおけるコマンドの一般的な理解を提供します。各ビルトインコマンドの詳細については、ビルトインコマンドリファレンスを参照してください。