Class: CDialogHolder

UI binding for CDialogHolder.

Source

C++ class CDialogHolder

Custom Constructor

CDialogHolder

Remarks

Manages the dialog render list and input receiver stack. It does not create or own dialog windows.

Constructors

Constructor

new CDialogHolder(): CDialogHolder;

Returns

CDialogHolder

Methods

AddDialogToRender()

AddDialogToRender(window: CUIWindow): void;

Add a dialog to rendering.

Parameters

Parameter	Type	Description
window	CUIWindow	Dialog window.

Returns

void

Remarks

The holder shows the window and skips duplicate active entries.

---

MainInputReceiver()

MainInputReceiver(): Nullable<CUIDialogWnd>;

Returns

Nullable<CUIDialogWnd>

Current main input receiver, or null when no dialog owns input.

---

RemoveDialogToRender()

RemoveDialogToRender(window: CUIWindow): void;

Remove a dialog from rendering.

Parameters

Parameter	Type	Description
window	CUIWindow	Dialog window.

Returns

void

Remarks

The holder hides and disables the window, then removes it from the active render list on update.

---

SetMainInputReceiver()

SetMainInputReceiver(window: Nillable<CUIDialogWnd>, find_remove: boolean): void;

Set the main input receiver.

Parameters

Parameter	Type	Description
window	Nillable<CUIDialogWnd>	Dialog window, or null to pop the current receiver.
find_remove	boolean	Whether to remove the previous receiver if found.

Returns

void

Remarks

Passing find_remove removes the matching receiver from the stack. Passing null pops the current receiver.

---

start_stop_menu()

start_stop_menu(window: CUIDialogWnd, value: boolean): void;

Start or stop an in-game menu.

Parameters

Parameter	Type	Description
window	CUIDialogWnd	Menu window.
value	boolean	Whether the menu should be active.

Returns

void

Remarks

This toggles the dialog through the holder, including cursor and HUD indicator handling.

---

TopInputReceiver()

TopInputReceiver(): Nullable<CUIDialogWnd>;

Returns

Nullable<CUIDialogWnd>

Current top input receiver, or null when no dialog owns input.