Class: MockCScriptXmlInit

Mock xml file with forms sources.

Implements

• CScriptXmlInit

Constructors

Constructor

new MockCScriptXmlInit(): MockCScriptXmlInit;

Returns

MockCScriptXmlInit

Methods

create()

static create(): MockCScriptXmlInit;

Returns

MockCScriptXmlInit

---

mock()

static mock(): CScriptXmlInit;

Returns

CScriptXmlInit

Properties

Init3tButton

Init3tButton: Mock<() => CUI3tButton>;

Create and initialize a three-state button from XML.

Remarks

When parent is provided, the created control is marked for parent-owned deletion.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created button.

Implementation of

CScriptXmlInit.Init3tButton

---

InitAnimStatic

InitAnimStatic: Mock<() => CUIStatic>;

Create and initialize an animated static from XML.

Remarks

When parent is provided, the created control is marked for parent-owned deletion.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created static control.

Implementation of

CScriptXmlInit.InitAnimStatic

---

InitAutoStaticGroup

InitAutoStaticGroup: Mock<UnknownFunction>;

Initialize a group of auto-created static controls under an existing window.

Remarks

Reads static child definitions from the selected XML node and attaches them to parent. Requires a non-null parent window.

Param

selector

XML node path.

Param

parent

Parent window.

Implementation of

CScriptXmlInit.InitAutoStaticGroup

---

InitButton

InitButton: Mock<() => CUIButton>;

Create and initialize a button from XML.

Remarks

The created button is marked for auto-delete by the native binding.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created button.

Implementation of

CScriptXmlInit.InitButton

---

InitCDkey

InitCDkey: Mock<() => CUIEditBox>;

Create and initialize a CD key edit box from XML.

Remarks

Assigns CD-key callbacks and applies the current option value after initialization.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created edit box.

Implementation of

CScriptXmlInit.InitCDkey

---

InitCheck

InitCheck: Mock<() => CUICheckButton>;

Create and initialize a check button from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created check button.

Implementation of

CScriptXmlInit.InitCheck

---

InitComboBox

InitComboBox: Mock<() => CUIComboBox>;

Create and initialize a combo box from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created combo box.

Implementation of

CScriptXmlInit.InitComboBox

---

InitEditBox

InitEditBox: Mock<() => CUIEditBox>;

Create and initialize an edit box from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created edit box.

Implementation of

CScriptXmlInit.InitEditBox

---

InitFrame

InitFrame: Mock<() => CUIFrameWindow>;

Create and initialize a frame window from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created frame window.

Implementation of

CScriptXmlInit.InitFrame

---

InitFrameLine

InitFrameLine: Mock<() => CUIFrameLineWnd>;

Create and initialize a frame line from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created frame line.

Implementation of

CScriptXmlInit.InitFrameLine

---

InitHint

InitHint: Mock<() => UIHint>;

Create and initialize a hint window from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created hint window.

Implementation of

CScriptXmlInit.InitHint

---

InitKeyBinding

InitKeyBinding: Mock<() => CUIWindow>;

Create and initialize a key binding control from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created key binding window.

Implementation of

CScriptXmlInit.InitKeyBinding

---

InitLabel

InitLabel: Mock<() => CUIStatic>;

Create and initialize a label from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created label static.

Implementation of

CScriptXmlInit.InitLabel

---

InitList

InitList: Mock<() => CUIListWnd>;

Create and initialize a list window from XML.

Remarks

When parent is provided, the created control is marked for parent-owned deletion.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created list window.

Implementation of

CScriptXmlInit.InitList

---

InitListBox

InitListBox: <T>(selector: string, parent: CUIWindow | null | undefined) => CUIListBox<T>;

Create and initialize a list box from XML.

Type Parameters

Type Parameter	Default type
T extends CUIListBoxItem	CUIListBoxItem

Parameters

Parameter	Type	Description
selector	string	XML node path.
parent	CUIWindow | null | undefined	Optional parent window.

Returns

CUIListBox<T>

Created list box.

Remarks

When parent is provided, the created control is marked for parent-owned deletion.

Implementation of

CScriptXmlInit.InitListBox

---

InitMapInfo

InitMapInfo: Mock<() => CUIMapInfo>;

Create and initialize a map info control from XML.

Remarks

Initializes both the base window rect and the map-info content area from the XML node.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created map info control.

Implementation of

CScriptXmlInit.InitMapInfo

---

InitMapList

InitMapList: Mock<() => CUIMapList>;

Create and initialize a map list control from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created map list control.

Implementation of

CScriptXmlInit.InitMapList

---

InitMMShniaga

InitMMShniaga: Mock<() => CUIMMShniaga>;

Create and initialize a main-menu shniaga control from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created main-menu shniaga control.

Implementation of

CScriptXmlInit.InitMMShniaga

---

InitMPPlayerName

InitMPPlayerName: Mock<() => CUIEditBox>;

Create and initialize a multiplayer player-name edit box from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created edit box.

Implementation of

CScriptXmlInit.InitMPPlayerName

---

InitProgressBar

InitProgressBar: Mock<() => CUIProgressBar>;

Create and initialize a progress bar from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created progress bar.

Implementation of

CScriptXmlInit.InitProgressBar

---

InitScrollView

InitScrollView: Mock<() => CUIScrollView>;

Create and initialize a scroll view from XML.

Remarks

Child controls created under this parent are added through AddWindow().

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created scroll view.

Implementation of

CScriptXmlInit.InitScrollView

---

InitServerList

InitServerList: Mock<() => CServerList>;

Create and initialize a server list from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created server list.

Implementation of

CScriptXmlInit.InitServerList

---

InitSleepStatic

InitSleepStatic: Mock<() => CUISleepStatic>;

Create and initialize a sleep static from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created sleep static.

Implementation of

CScriptXmlInit.InitSleepStatic

---

InitSpinFlt

InitSpinFlt: Mock<() => CUISpinFlt>;

Create and initialize a float spin control from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created spin control.

Implementation of

CScriptXmlInit.InitSpinFlt

---

InitSpinNum

InitSpinNum: Mock<() => CUISpinNum>;

Create and initialize an integer spin control from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created spin control.

Implementation of

CScriptXmlInit.InitSpinNum

---

InitSpinText

InitSpinText: Mock<() => CUISpinText>;

Create and initialize a text spin control from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created spin control.

Implementation of

CScriptXmlInit.InitSpinText

---

InitStatic

InitStatic: Mock<() => CUIStatic>;

Create and initialize a static control from XML.

Remarks

InitLabel() is bound to the same native initializer as this method.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created static control.

Implementation of

CScriptXmlInit.InitStatic

---

InitTab

InitTab: Mock<() => CUITabControl>;

Create and initialize a tab control from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created tab control.

Implementation of

CScriptXmlInit.InitTab

---

InitTextWnd

InitTextWnd: Mock<() => CUITextWnd>;

Create and initialize a text window from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created text window.

Implementation of

CScriptXmlInit.InitTextWnd

---

InitTrackBar

InitTrackBar: Mock<() => CUITrackBar>;

Create and initialize a track bar from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created track bar.

Implementation of

CScriptXmlInit.InitTrackBar

---

InitVerList

InitVerList: Mock<() => CUIVersionList>;

Create and initialize a version list from XML.

Param

selector

XML node path.

Param

parent

Optional parent window.

Returns

Created version list.

Implementation of

CScriptXmlInit.InitVerList

---

InitWindow

InitWindow: Mock<() => CUIWindow>;

Initialize a window already created by script.

Remarks

This does not create a child window. It applies XML properties to the passed window and does not attach it to a parent.

Param

selector

XML node path.

Param

index

XML node index.

Param

parent

Window to initialize.

Implementation of

CScriptXmlInit.InitWindow

---

ParseFile

ParseFile: Mock<UnknownFunction>;

Load a UI XML file from the configured UI paths.

Remarks

Paths are resolved through the engine config/UI path stack, including the active and default UI paths.

Param

path

XML file path.

Implementation of

CScriptXmlInit.ParseFile

---

ParseShTexInfo

ParseShTexInfo: Mock<UnknownFunction>;

Load shared texture metadata from an XML file.

Remarks

Missing files are ignored by the native loader. Duplicate texture ids from this file replace existing entries.

Param

path

XML file path.

Implementation of

CScriptXmlInit.ParseShTexInfo