Skip to content

Godot 内蔵 KonadoScript エディター

Konado プラグインを有効にした後、ファイルシステムドックで .ks ファイルをダブルクリックすると、.gd ファイルと同じように Godot のスクリプトワークスペースで開きます。KonadoScript は下部ドックではなく、Godot 標準のコードエディターとドキュメントタブを使用します。

編集機能

  • Godot のスクリプトタブで .ks.gd、その他のスクリプトをまとめて編集
  • .ks の編集中は左上のスクリプト一覧をコンポーネント/命令ツリーに切り替える。初回表示時のコンポーネント領域と分岐領域の高さは 2:1。見出し右側のスライド式スイッチですべてのグループを展開/折りたたみでき、折りたたみ後も最上位カテゴリは残る。項目を選ぶと対応する文を挿入し、左下のメンバーアウトラインは分岐移動用として維持
  • 「オンラインドキュメント」からエディター言語に対応する 2.4 LTS または latest 文書を開く。.ks の編集中は KonadoScript 非対応の Godot API ヘルプ検索を非表示にし、他のスクリプト言語へ切り替えると Godot 本来の表示へ復元
  • 現在のシナリオに言語バリアントがある場合は、「オンラインドキュメント」の隣にある選択欄からデフォルト版と検出済みのローカライズ版を直接切り替え
  • 元に戻す・やり直し、未保存状態、外部変更、終了確認を Godot が一括管理
  • スクリプトエディターの検索と置換、行移動、ズーム、ブックマーク、ショートカットを利用
  • ファイルシステムの「作成」メニューから、有効な初期内容を含む KonadoScript を新規作成
  • メンバーアウトラインに branch 宣言を表示。分岐、変数、シグナルで定義へ移動、参照検索、安全な名前変更を利用可能
  • 背景、アクター、状態、モーション、BGM、効果音、ボイス、カメラ設定、jump パスを Ctrl キー(macOS では Command キー)を押しながらクリックし、実際のシーン、リソース、または KonadoScript を開く。候補が複数ある場合は選択リストを表示
  • 命令やリソース識別子にカーソルを合わせると、シグネチャ、用途、解決先パス、未解決状態を表示。実在する移動先がある範囲だけをリンクとして下線表示
  • コンテキストメニューから文書または選択範囲の整形、修正候補、定義へ移動、参照検索、安全な名前変更を実行。ファイルをまたぐリソース名変更は変更プレビューを先に表示
  • 条件ブロックと全画面テキストブロックを Godot のインデント設定に従って自動整形
  • 元の .ks に直接保存し、リソースローダーがコンパイルした実行時用 KND_Shot を更新

ハイライトとコード補完

KND_KsHighlighter は Godot の EditorSyntaxHighlighter を基に実装され、プラグイン起動時にスクリプトエディターへ登録されます。ハイライトとコード補完は KS_LanguageCatalog を共有し、有効なキーワードはパーサーの KS_Token.KEYWORDS を基準とします。自動テストが両者の整合性を確認します。

補完は命令、サブコマンド、挿入可能なステートメントテンプレート、引数シグネチャを表示します。さらにプロジェクト内の KonadoScript パス、キャラクター、状態、アクション、背景、音声、カメラを索引化します。状態とカスタムモーションは選択したアクターに合わせて絞り込まれ、空白を含む引用テキストの後でもボイスを補完できます。現在のドキュメント内の分岐、変数、シグナルも即座に候補へ追加します。ハイライト用の式は初回だけコンパイルされ、各行には色が変わる位置だけを記録します。

デフォルトのハイライトリソース:

text
res://addons/konado/editor/ks_editor/highlighter.tres

他の CodeEdit でもハイライターを直接利用できます。

gdscript
set_syntax_highlighter(KND_KsHighlighter.new())

ライブ診断

入力を少し止めると、Godot は KonadoScript 言語ブリッジを通じて、実行時用 KND_Shot を生成せずに字句・構文・意味解析を実行します。エラーと警告は対象の行とスクリプトエディター内蔵の問題パネルに表示され、Godot エディターの言語に応じて中国語または英語になります。複数行の独立したエラーを一度に報告し、余分な引数、不正な数値や真偽値、無効なジャンプパス、未知のリソース ID、欠落した対象ファイル、アクターのライフサイクル、ローカライズ版の構造を検査します。不正な入力でライブ解析が停止することはありません。

エラー範囲にカーソルを合わせると、内容に応じて幅と高さが変わる診断カードが表示されます。診断には可能性の高い順に最大 3 個の「試す」候補を表示できます。判断が必要な選択肢は「安全なクイック修正をすべて適用」の対象外です。自動編集できない問題にはリソース設定またはドキュメントへの入口が表示されます。修正は 1 回の取り消し可能な操作として適用され、キャレット、選択範囲、複数キャレット、折りたたみ、スクロール位置を保持します。

問題をクリックすると該当位置へ移動できます。既存ファイルに構文エラーがあっても、スクリプトエディターで開いて修正できます。保存後はリソースローダーが正式なコンパイルを行うため、ライブ診断は最終的な読み込み結果の代わりにはなりません。

実行時デバッグ

Godot のブレークポイントで KonadoScript の実行を制御できます。ブレークポイントに到達すると対応する .ks 行が開き、現在のショット、ノード、永続変数、一時変数が表示されます。デバッガータブには続行、ステップ、次の行で一時停止の操作があります。リリースエクスポートではエディターのデバッグセッションは有効になりません。

ショートカット

操作Windows / LinuxmacOS
保存Ctrl+SCommand+S
現在のタブを閉じるCtrl+WCommand+W
検索Ctrl+FCommand+F
検索と置換Ctrl+HCommand+Option+F
行へ移動Ctrl+LCommand+L

Released under BSD3-Clause License.