XRF X-Ray 16 SDK

Appearance

Class: MockCUISpinText ​

Mock base window class.

Extends ​

Implements ​

  • CUISpinText

Accessors ​

__name ​

Get Signature ​

ts
get __name(): string;
Returns ​

string

Implementation of ​

ts
CUISpinText.__name

Inherited from ​

MockCUICustomSpin.__name

__name ​

Get Signature ​

ts
get static __name(): string;
Returns ​

string

Inherited from ​

MockCUICustomSpin.__name

Constructors ​

Constructor ​

ts
new MockCUISpinText(): MockCUISpinText;

Returns ​

MockCUISpinText

Inherited from ​

MockCUICustomSpin.constructor

Methods ​

GetHeight() ​

ts
GetHeight(): number;

Returns ​

number

Window height.

Implementation of ​

ts
CUISpinText.GetHeight

Inherited from ​

MockCUICustomSpin.GetHeight

GetWidth() ​

ts
GetWidth(): number;

Returns ​

number

Window width.

Implementation of ​

ts
CUISpinText.GetWidth

Inherited from ​

MockCUICustomSpin.GetWidth

OnKeyboard() ​

ts
OnKeyboard(): boolean;

Returns ​

boolean

Inherited from ​

MockCUICustomSpin.OnKeyboard

Show() ​

ts
Show(isShown: boolean): void;

Show or hide the window.

Parameters ​

ParameterType
isShownboolean

Returns ​

void

Remarks ​

Visibility does not attach, detach, enable, or disable the window.

Implementation of ​

ts
CUISpinText.Show

Inherited from ​

MockCUICustomSpin.Show

create() ​

ts
static create(): MockCUISpinText;

Returns ​

MockCUISpinText

Overrides ​

MockCUICustomSpin.create

mock() ​

ts
static mock(): CUISpinText;

Returns ​

CUISpinText

Overrides ​

MockCUICustomSpin.mock

Properties ​

AttachChild ​

ts
AttachChild: Mock<(window: CUIWindow) => void>;

Attach a child window.

Remarks ​

The Lua binding adopts child; after attachment, treat the parent as owning its lifetime.

Param ​

child

Child window.

Implementation of ​

ts
CUISpinText.AttachChild

Inherited from ​

MockCUICustomSpin.AttachChild

children ​

ts
children: CUIWindow[] = [];

Inherited from ​

MockCUICustomSpin.children

DetachChild ​

ts
DetachChild: Mock<(window: CUIWindow) => void>;

Detach a child window.

Remarks ​

Detaching removes the parent relation. It does not reinitialize the window or attach it elsewhere.

Param ​

child

Child window.

Implementation of ​

ts
CUISpinText.DetachChild

Inherited from ​

MockCUICustomSpin.DetachChild

Enable ​

ts
Enable: Mock<(isEnabled: boolean) => void>;

Enable or disable interaction.

Remarks ​

Enabled state and visibility are separate. Hidden controls can still be enabled.

Param ​

is_enabled

Whether the window should be enabled.

Implementation of ​

ts
CUISpinText.Enable

Inherited from ​

MockCUICustomSpin.Enable

focusReceiveTime ​

ts
focusReceiveTime: number = 0;

Inherited from ​

MockCUICustomSpin.focusReceiveTime

FocusReceiveTime ​

ts
FocusReceiveTime: Mock<() => number>;

Returns ​

Level time when this window received focus.

Implementation of ​

ts
CUISpinText.FocusReceiveTime

Inherited from ​

MockCUICustomSpin.FocusReceiveTime

GetAbsoluteRect ​

ts
GetAbsoluteRect: Mock<() => Frect>;

Returns ​

Window rectangle in screen coordinates.

Implementation of ​

ts
CUISpinText.GetAbsoluteRect

Inherited from ​

MockCUICustomSpin.GetAbsoluteRect

GetFont ​

ts
GetFont: Mock<() => CGameFont>;

Get the font assigned to this window.

Remarks ​

Text controls need a font assigned before drawing custom text reliably.

Returns ​

Font assigned to this window.

Implementation of ​

ts
CUISpinText.GetFont

Inherited from ​

MockCUICustomSpin.GetFont

GetMouseX ​

ts
GetMouseX: Mock<() => number>;

Get cursor X coordinate stored on this window.

Since ​

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

Source ​

src/xrUICore/ui_export_script.cpp, CUIWindow.GetMouseX binding.

Returns ​

Current cursor X coordinate.

Implementation of ​

ts
CUISpinText.GetMouseX

Inherited from ​

MockCUICustomSpin.GetMouseX

GetMouseY ​

ts
GetMouseY: Mock<() => number>;

Get cursor Y coordinate stored on this window.

Since ​

OpenXRay 2026-01-01, e3b0e3c5, PR #2028

Source ​

src/xrUICore/ui_export_script.cpp, CUIWindow.GetMouseY binding.

Returns ​

Current cursor Y coordinate.

Implementation of ​

ts
CUISpinText.GetMouseY

Inherited from ​

MockCUICustomSpin.GetMouseY

GetText ​

ts
GetText: Mock<() => string>;

Returns ​

Current spin text.

Implementation of ​

ts
CUISpinText.GetText

Inherited from ​

MockCUICustomSpin.GetText

GetWndPos ​

ts
GetWndPos: Mock<() => vector2>;

Returns ​

Window position relative to its parent.

Implementation of ​

ts
CUISpinText.GetWndPos

Inherited from ​

MockCUICustomSpin.GetWndPos

Init ​

ts
Init: Mock<(rectOrX: number | Frect, y?: number, width?: number, height?: number) => void>;

Initialize window rectangle.

Param ​

frect

Window rectangle.

Implementation of ​

ts
CUISpinText.Init

Inherited from ​

MockCUICustomSpin.Init

isAutoDelete ​

ts
isAutoDelete: boolean = false;

Inherited from ​

MockCUICustomSpin.isAutoDelete

IsAutoDelete ​

ts
IsAutoDelete: Mock<() => boolean>;

Returns ​

Whether the engine owns and deletes this window with its parent.

Implementation of ​

ts
CUISpinText.IsAutoDelete

Inherited from ​

MockCUICustomSpin.IsAutoDelete

IsCursorOverWindow ​

ts
IsCursorOverWindow: Mock<() => boolean>;

Returns ​

Whether the UI cursor is currently over this window.

Implementation of ​

ts
CUISpinText.IsCursorOverWindow

Inherited from ​

MockCUICustomSpin.IsCursorOverWindow

isEnabled ​

ts
isEnabled: boolean = false;

Inherited from ​

MockCUICustomSpin.isEnabled

IsEnabled ​

ts
IsEnabled: Mock<() => boolean>;

Returns ​

Whether the window accepts interaction.

Implementation of ​

ts
CUISpinText.IsEnabled

Inherited from ​

MockCUICustomSpin.IsEnabled

isPostProcessMode ​

ts
isPostProcessMode: boolean = false;

Inherited from ​

MockCUICustomSpin.isPostProcessMode

isShown ​

ts
isShown: boolean = false;

Inherited from ​

MockCUICustomSpin.isShown

IsShown ​

ts
IsShown: Mock<() => boolean>;

Returns ​

Whether the window is visible.

Implementation of ​

ts
CUISpinText.IsShown

Inherited from ​

MockCUICustomSpin.IsShown

mouseX ​

ts
mouseX: number = 0;

Inherited from ​

MockCUICustomSpin.mouseX

mouseY ​

ts
mouseY: number = 0;

Inherited from ​

MockCUICustomSpin.mouseY

ResetPPMode ​

ts
ResetPPMode: Mock<() => void>;

Disable post-process mode for this window.

Remarks ​

Pair with CUIWindow.SetPPMode when a window no longer needs post-process rendering.

Implementation of ​

ts
CUISpinText.ResetPPMode

Inherited from ​

MockCUICustomSpin.ResetPPMode

SetAutoDelete ​

ts
SetAutoDelete: Mock<(isAutoDelete: boolean) => void>;

Set whether the parent owns this child window.

Remarks ​

Use this for script-created windows that are attached to a parent and should be cleaned up with the UI tree.

Param ​

auto_delete

Whether the engine should delete the child automatically.

Implementation of ​

ts
CUISpinText.SetAutoDelete

Inherited from ​

MockCUICustomSpin.SetAutoDelete

SetFont ​

ts
SetFont: Mock<(font: CGameFont) => void>;

Set the font used by this window.

Param ​

font

Font object.

Implementation of ​

ts
CUISpinText.SetFont

Inherited from ​

MockCUICustomSpin.SetFont

SetHeight ​

ts
SetHeight: Mock<(height: number) => void>;

Set window height.

Param ​

height

New height.

Implementation of ​

ts
CUISpinText.SetHeight

Inherited from ​

MockCUICustomSpin.SetHeight

SetPPMode ​

ts
SetPPMode: Mock<() => void>;

Enable post-process mode for this window.

Remarks ​

Use for windows meant to be drawn through the post-process UI path, and reset it when the window returns to normal UI rendering.

Implementation of ​

ts
CUISpinText.SetPPMode

Inherited from ​

MockCUICustomSpin.SetPPMode

SetWidth ​

ts
SetWidth: Mock<(width: number) => void>;

Set window width.

Param ​

width

New width.

Implementation of ​

ts
CUISpinText.SetWidth

Inherited from ​

MockCUICustomSpin.SetWidth

SetWindowName ​

ts
SetWindowName: Mock<(name: string) => void>;

Set debug/window name.

Param ​

name

Window name.

Implementation of ​

ts
CUISpinText.SetWindowName

Inherited from ​

MockCUICustomSpin.SetWindowName

SetWndPos ​

ts
SetWndPos: Mock<(positionOrX: number | vector2, y?: number) => void>;

Set window position.

Param ​

vector2

New position.

Implementation of ​

ts
CUISpinText.SetWndPos

Inherited from ​

MockCUICustomSpin.SetWndPos

SetWndRect ​

ts
SetWndRect: Mock<(rectOrX: number | Frect, y?: number, width?: number, height?: number) => void>;

Set window rectangle.

Param ​

rect

New rectangle.

Implementation of ​

ts
CUISpinText.SetWndRect

Inherited from ​

MockCUICustomSpin.SetWndRect

SetWndSize ​

ts
SetWndSize: Mock<(sizeOrWidth: number | vector2, height?: number) => void>;

Set window size.

Param ​

vector2

New size.

Implementation of ​

ts
CUISpinText.SetWndSize

Inherited from ​

MockCUICustomSpin.SetWndSize

text ​

ts
text: string = "test-cs";

Inherited from ​

MockCUICustomSpin.text

windowFont ​

ts
windowFont: CGameFont | null = null;

Inherited from ​

MockCUICustomSpin.windowFont

windowName ​

ts
windowName: string | null = null;

Inherited from ​

MockCUICustomSpin.windowName

WindowName ​

ts
WindowName: Mock<() => string>;

Returns ​

Window name.

Implementation of ​

ts
CUISpinText.WindowName

Inherited from ​

MockCUICustomSpin.WindowName

windowPosition ​

ts
windowPosition: vector2;

Inherited from ​

MockCUICustomSpin.windowPosition

windowRect ​

ts
windowRect: Frect | null = null;

Inherited from ​

MockCUICustomSpin.windowRect

windowSize ​

ts
windowSize: vector2;

Inherited from ​

MockCUICustomSpin.windowSize