Dialog¶
Dialog クラスは、Elements ベースの汎用ダイアログを TJS から駆動するための
クラスです ( SDL3 ビルド限定 )。
JSON / JSONC ( コメントと末尾カンマを許容 ) 形式のレイアウト定義を渡して、 ボタン・チェックボックス・トグル・テキスト入力等を含むダイアログを表示 できます。動作モードは 3 種類あります。
レイアウト定義は JSON / JSONC 文字列のほか、TJS の Dictionary / Array を そのまま渡せる Dict 系メソッド ( showDict / showModalDict ) も利用できます。
- 非モーダル (オーバーレイ表示) showJson / showFile で表示します。表示中もメイン ループは止まらず、ボタン押下や値変更があるたびに onAction が逐次発火します。明示的に close を呼ぶか、ダイアログ側で 閉じるイベントが起きるまで残ります。
- ブロッキングモーダル (独立ウィンドウ) showModalJson / showModalFile に タイトル ( および幅・高さ ) を渡して呼ぶと、新しいネイティブウィンドウ が開き、閉じるまで TJS の実行を止めて結果を Dictionary で返します。
- ブロッキングモーダル (ゲーム画面へのオーバーレイ) showModalJson / showModalFile を JSON 1 引数だけで呼ぶと、独立ウィンドウを開かずに既存のゲーム画面に 重ねて表示し、閉じるまでブロッキングします。
複数画面を遷移する「フロー」の駆動にも対応しています。ブロッキング 実行は showFlow / showFlowScreens、 非モーダル ( 常駐 ) 実行は startFlow / startFlowScreens を使用します。画面遷移の タイミングで onScreen / onScreenLeave が発火し、widget 操作は引き続き onAction に通知されます。
非モーダルダイアログは複数同時に表示できます ( z-order 付きで重ね
描画され、マウスはヒットテスト、キーボードは最前面の handler 優先で
フォーカスが移ります )。grabFocus 引数を偽にすると、フォーカスを
取らない常駐 HUD として表示できます。
JSON 仕様の要素タイプ ( label / button / input_box / checkbox / toggle /
vtile / htile / vspacer / hspacer 等 ) や属性、"input" ノードによる
キーボード / ゲームパッド操作の設定詳細は elements_modal の README
を参照してください。
KRKRZ_USE_ELEMENTS=OFF でビルドした exe では Dialog クラスは利用できません。
WINVER (Windows ネイティブ / D3D11) ビルドでも Dialog は利用できます
(非モーダル / overlay モーダル / 独立ウィンドウモーダル / フロー /
テキスト入力すべてに対応)。
メンバー一覧¶
コンストラクタ¶
プロパティ¶
メソッド¶
- showJson
- showFile
- showDict
- showModalJson
- showModalFile
- showModalDict
- dictToJson
- showFlow
- showFlowScreens
- startFlow
- startFlowScreens
- close
- registerFont
- registerFontDir
イベント¶
Dialog¶
コンストラクタ
解説
Dialog オブジェクトの構築
Dialog クラスのオブジェクトを構築します。
defaultFontFamily¶
プロパティ \ アクセス: r/w
型: string
解説
デフォルトフォントファミリ
Elements の theme に適用される label / button 等の既定フォントファミリ 名 ( カンマ区切り ) を取得 / 設定します。値の getter / setter とも Elements ランタイムが初期化されたあと ( 最初のダイアログ表示後 ) に 意味を持ちます。
active¶
プロパティ \ アクセス: r
型: bool
解説
この Dialog インスタンスがアクティブかどうか ( 読み取り専用 )
この Dialog で開いた非モーダルダイアログ / フローが現在アクティブな ときに真になります。close を呼んだ直後はまだ teardown が 終わっていないため真のままで、teardown 完了後に偽に切り替わります。
非モーダル UI を閉じてから次のモーダルダイアログを起動したい、 といったタイミング制御に使います。
showJson¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
json |
|
JSON / JSONC 形式のレイアウト定義文字列を指定します。 |
grabFocus |
true |
キーボードフォーカスを取得するかどうか ( 既定 true )。 true のときはパネルがキーボードフォーカスを取得し、input_box 等への文字 入力やウィジェットのキー操作ができます ( ただしパネルが処理するキーは ホスト側 Window.onKeyDown には届きません )。 false のときはフォーカスを取らず、キー入力はホスト ( Window ) へ通ります。 ゲーム側のホットキーを活かしたい常駐 HUD 的なパネルや、独自のキー操作 ( 画面切替等 ) と併用する場合に指定します。この場合パネル内の input_box 等 への文字入力はできません。マウス操作は grabFocus に関わらず有効です。 |
戻り値
表示開始に成功したら真を返します。
解説
JSON 文字列で非モーダルダイアログを表示する
指定された JSON / JSONC 形式のレイアウト定義からダイアログを構築し、 既存のゲーム画面にオーバーレイ表示します。表示中もメインループは 止まらず、ユーザ操作のたびに onAction が発火します。 表示を終わらせるには close を呼んでください。
関連: Dialog.showFile / Dialog.onAction / Dialog.close
showFile¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
path |
|
JSON / JSONC ファイルのパスを指定します。 |
grabFocus |
true |
キーボードフォーカスを取得するかどうか ( 既定 true )。詳細は showJson を参照。 |
戻り値
表示開始に成功したら真を返します。
解説
ファイルから非モーダルダイアログを表示する
指定パスから JSON / JSONC レイアウト定義を読み込み、showJson と同じ動作で表示します。パスは Storages 経由のパス指定が使えます。
関連: Dialog.showJson
showDict¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
dict |
|
レイアウト定義の Dictionary を指定します。 |
grabFocus |
true |
キーボードフォーカスを取得するかどうか ( 既定 true )。詳細は showJson を参照。 |
戻り値
表示開始に成功したら真を返します。
解説
Dictionary で非モーダルダイアログを表示する
showJson のレイアウトを JSON 文字列ではなく TJS の Dictionary / Array で直接指定する版です。内部で JSON へ変換して 同じ経路で表示します ( 変換仕様は dictToJson と同じ )。
関連: Dialog.showJson / Dialog.dictToJson
showModalJson¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
json |
|
JSON / JSONC 形式のレイアウト定義文字列を指定します。 |
title |
"" |
独立ウィンドウのタイトルを指定します ( 省略するとオーバーレイモードに切替わります )。 |
width |
800 |
独立ウィンドウの幅をピクセル単位で指定します ( 既定値 800 )。 |
height |
600 |
独立ウィンドウの高さをピクセル単位で指定します ( 既定値 600 )。 |
戻り値
action と values を保持する Dictionary が返ります。
解説
JSON 文字列でモーダルダイアログを表示する
指定された JSON / JSONC 定義からダイアログを構築し、閉じるまで TJS の実行を止めてブロッキング表示します。
- 引数を JSON 1 個だけで呼ぶと、既存のゲーム画面にオーバーレイ表示 ( in-game modal ) します。
- title 以降を渡すと独立した新しいネイティブウィンドウを開いて表示 します。
戻り値は次の構造の Dictionary です。
%[
action: <閉じた button の id ( Esc / × は "" )>,
values: %[
モーダル表示中も onAction は発火しますが、ダイアログを
閉じるのは "close_on_click": true 指定の button が押されたとき
( および Esc / × による中断 ) だけです。
関連: Dialog.showModalFile / Dialog.onAction
showModalFile¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
path |
|
JSON / JSONC ファイルのパスを指定します。 |
title |
"" |
独立ウィンドウのタイトルを指定します ( 省略するとオーバーレイモードに切替わります )。 |
width |
800 |
独立ウィンドウの幅をピクセル単位で指定します ( 既定値 800 )。 |
height |
600 |
独立ウィンドウの高さをピクセル単位で指定します ( 既定値 600 )。 |
戻り値
action と values を保持する Dictionary が返ります。
解説
ファイルからモーダルダイアログを表示する
指定パスから JSON / JSONC レイアウト定義を読み込んで showModalJson と同じ動作で表示します。パスは Storages 経由のパス指定が使えます。
showModalDict¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
dict |
|
レイアウト定義の Dictionary を指定します。 |
title |
"" |
独立ウィンドウのタイトルを指定します ( 省略するとオーバーレイモードに切替わります )。 |
width |
800 |
独立ウィンドウの幅をピクセル単位で指定します ( 既定値 800 )。 |
height |
600 |
独立ウィンドウの高さをピクセル単位で指定します ( 既定値 600 )。 |
戻り値
action と values を保持する Dictionary が返ります。
解説
Dictionary でモーダルダイアログを表示する
showModalJson のレイアウトを TJS の Dictionary / Array で直接指定する版です。引数 1 個で呼ぶとオーバーレイ、title 以降を渡すと独立ウィンドウで表示する点、および戻り値の形式は showModalJson と同じです。
関連: Dialog.showModalJson / Dialog.showDict
dictToJson¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
value |
|
変換する値 ( Dictionary / Array / 基本型 ) を指定します。 |
戻り値
JSON 文字列が返ります。
解説
Dictionary / Array を JSON 文字列へ変換する
showDict / showModalDict が内部で行う
変換をそのまま呼び出すユーティリティです。Dictionary で組み立てた
レイアウトを JSON 資材として保存する、変換結果を確認する、といった
用途に使えます。インスタンスを作らず Dialog.dictToJson(...) として
呼べます。
対応する値の型は void / Integer / Real / String / Dictionary / Array です。それ以外 ( Octet や一般のオブジェクト、循環参照、非有限の実数 ) は例外になります。
関連: Dialog.showDict
showFlow¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
manifestPath |
|
app.jsonc マニフェストの Storages パスを指定します。 |
戻り値
action と values を保持する Dictionary が返ります。
解説
マニフェストから複数画面フローをブロッキング表示する
app.jsonc 形式のマニフェスト ( Storages 経由のパス指定 ) を読み込んで、
複数画面の遷移を含むフローを既存のゲーム画面にオーバーレイで実行します。
フロー終了まで TJS の実行を止め、最後に閉じた画面の Dictionary
%[ action, values ] を返します。
画面が切り替わるたびに onScreen / onScreenLeave、 各 widget の操作で onAction が発火します。
関連: Dialog.showFlowScreens / Dialog.startFlow
showFlowScreens¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
screensDict |
|
画面名 ( 文字列 ) をレイアウト定義 ( JSON 文字列、または Dictionary / Array ) にマップする Dictionary。両形式の混在も可能です。 |
entry |
|
起点画面名 ( screensDict のキー ) を指定します。 |
戻り値
action と values を保持する Dictionary が返ります。
解説
インライン定義から複数画面フローをブロッキング表示する
ファイル I/O を介さず、Dictionary で画面名 → レイアウト定義を渡して フローを実行する showFlow のインライン版です。 動作と戻り値は showFlow と同じです。
関連: Dialog.showFlow / Dialog.startFlowScreens
startFlow¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
manifestPath |
|
app.jsonc マニフェストの Storages パスを指定します。 |
grabFocus |
true |
真でキーボード / ゲームパッドフォーカスを取ります ( 既定値 真 )。偽を指定するとフォーカスを取らない常駐 HUD として表示されます。 |
戻り値
開始に成功したら真を返します。
解説
非モーダル ( 常駐 ) 複数画面フローを開始する
showFlow と同じマニフェストを非モーダル ( 非ブロッキング ) で 開始し、即座に戻ります。ゲーム画面に出しっぱなしで進行させられるため、 メインメニューや HUD のような常駐 UI に適しています。
画面遷移は JSON 側 transitions 定義で行います。ボタン押下等を起点に
TJS 側で処理する場合は、"close_on_click" を指定しない button の
onAction で振り分けてください。明示的に終了させるには
close を呼び、teardown が完了したかどうかは
active で判別できます。
関連: Dialog.startFlowScreens / Dialog.showFlow / Dialog.active
startFlowScreens¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
screensDict |
|
画面名 ( 文字列 ) を JSON 文字列にマップする Dictionary。 |
entry |
|
起点画面名 ( screensDict のキー ) を指定します。 |
grabFocus |
true |
真でキーボード / ゲームパッドフォーカスを取ります ( 既定値 真 )。偽を指定するとフォーカスを取らない常駐 HUD として表示されます。 |
戻り値
開始に成功したら真を返します。
解説
インライン定義から非モーダル ( 常駐 ) 複数画面フローを開始する
showFlowScreens と同じ Dictionary 形式の画面定義を 非モーダル ( 非ブロッキング ) で開始する startFlow の インライン版です。
関連: Dialog.startFlow / Dialog.showFlowScreens
close¶
メソッド
解説
ダイアログを閉じる
このインスタンスで開いた非モーダル / モーダルダイアログ ( フロー含む ) を閉じます。他のインスタンスが開いたダイアログは閉じません。
内部の teardown は次フレームで行われるため、close を呼んだ直後でも しばらく active は真のままです。次のモーダルを安全に 起動したい場合は active が偽になるのを待ってください。
関連: Dialog.active
registerFont¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
family |
|
登録時に使うファミリ名を指定します。 |
path |
|
フォントファイル ( .ttf / .otf ) の Storages パスを指定します。 |
weight |
40 |
weight 値を指定します ( 既定値 40 = normal )。 |
slant |
0 |
slant 値を指定します ( 既定値 0 = normal )。 |
stretch |
50 |
stretch 値を指定します ( 既定値 50 = normal )。 |
戻り値
実際に登録された family 名 ( ThorVG embedded 優先 )。
解説
Elements 用フォントの登録
Elements ダイアログで使用するフォントを krkrz Storages 経由で登録 します。ThorVG がファイルから読み取った embedded family 名 ( 取れな かった場合は空文字 ) を戻り値として返します。スクリプトはこの戻り値 を見て theme への組込みやログ表示に利用できます。
weight / slant / stretch は font_constants の整数値です ( 詳細は
StoragesResourceLoader.h を参照 )。
registerFontDir¶
メソッド
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
dir |
|
登録対象ディレクトリの Storages パスを指定します。 |
戻り値
真が返ります ( ディレクトリが空でも例外にはなりません )。
解説
Elements 用フォントの一括登録
指定ディレクトリ配下の .ttf / .otf を全て列挙して登録します ( ファイル 名から family / weight / slant / stretch を推定 )。dir は Storages 経由の パス指定が使え、XP3 内のディレクトリでも構いません。
onScreen¶
イベント
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
name |
|
入った画面の名前 ( マニフェストの画面キー ) 。 |
解説
フロー画面遷移通知 ( 画面に入った )
showFlow / startFlow 系で実行している フローの画面に入ったタイミングで発火します。TJS 側で override して ください。
onScreenLeave¶
イベント
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
name |
|
出た画面の名前 ( マニフェストの画面キー ) 。 |
action |
|
画面を離れる契機となった button の id ( Esc / × は空文字列 ) 。 |
解説
フロー画面遷移通知 ( 画面から出た )
showFlow / startFlow 系で実行している フローの画面から離れるタイミングで発火します。TJS 側で override してください。
関連: Dialog.onScreen
onAction¶
イベント
引数
| 引数 | 既定値 | 説明 |
|---|---|---|
id |
|
発生元 widget の id 文字列。 |
payload |
|
widget が伴って渡す値 ( 上記参照 )。 |
解説
ダイアログ上の操作通知
ダイアログ上で発生したアクション ( button click や state widget の値 変化 ) を受け取るイベントです。TJS 側で override してください。
非モーダル ( showJson / showFile ) では
表示中ずっと発火します。モーダル ( showModalJson /
showModalFile ) でも、"close_on_click": true で
閉じる前に発生したアクションは順次このイベントに通知されます。
payload の内容は widget の種類によって変わります。
- button click ... void
- checkbox / toggle ... bool ( 変更後の値 )
- input_box ... string ( 編集後のテキスト )
- slider 等 ... 各 widget が渡す値