NativeElement

Defined in: client/api.d.ts:3065

A handle on one of the game’s own UI elements, driven where it stands.

Constructors

Constructor

new NativeElement(name, instanceId): NativeElement

Defined in: client/api.d.ts:3071

Rebuilds a handle for an element; use NativeUI.element() to get one.

Parameters

name

string

Element name, as its XML declares it.

instanceId

number

Instance id.

Returns

NativeElement

Methods

call()

call(fn, args?): any

Defined in: client/api.d.ts:3104

Calls one of the element’s declared functions. The element has to be loaded: show it first, or call this on one the game already has up.

Parameters

fn

string

A function the element’s XML declares, by its display name or its ActionScript name.

args?

(string | number | boolean | null)[]

Scalar arguments. They may also be passed loose, one per parameter.

Returns

any

What ActionScript returned, or null when the call failed.

---

getArray()

getArray(name): any[] | null

Defined in: client/api.d.ts:3134

Reads one of the element’s declared arrays.

Parameters

name

string

An array the element’s XML declares.

Returns

any[] | null

Its contents, or null when it is absent.

---

getClip()

getClip(name): { alpha: number; rotation: number; scaleX: number; scaleY: number; visible: boolean; x: number; y: number; } | null

Defined in: client/api.d.ts:3149

Reads one of the element’s declared movie clips back. Scale and alpha come back as multipliers, the way setClip takes them.

Parameters

name

string

A movie clip the element’s XML declares.

Returns

{ alpha: number; rotation: number; scaleX: number; scaleY: number; visible: boolean; x: number; y: number; } | null

Its display fields, or null when the clip is absent.

---

getVariable()

getVariable(name): any

Defined in: client/api.d.ts:3119

Reads one of the element’s declared variables.

Parameters

name

string

A variable the element’s XML declares.

Returns

any

The value, or null when it is absent.

---

gotoClip()

gotoClip(name, frameOrLabel, play?): boolean

Defined in: client/api.d.ts:3158

Moves a declared movie clip’s timeline, which is how a clip with several authored looks is switched between them.

Parameters

name

string

A movie clip the element’s XML declares.

frameOrLabel

string | number

A one-based frame number, or a frame label.

play?

boolean

Keep playing from there instead of stopping.

Returns

boolean

True when the frame or label resolved.

---

hide()

hide(): boolean

Defined in: client/api.d.ts:3170

Hides the element at once.

Returns

boolean

True when the element took it.

---

off()

off(event): void

Defined in: client/api.d.ts:3201

Removes every handler this resource put on one event.

Parameters

event

string

The event to stop listening for.

Returns

void

---

on()

on(event, handler): void

Defined in: client/api.d.ts:3195

Listens for one of the element’s declared events. This is how a click on a game screen reaches script.

Parameters

event

string

An event the element’s XML declares, by its display name.

handler

NativeElementHandler

Called on the next tick after the movie raises it.

Returns

void

---

reload()

reload(): boolean

Defined in: client/api.d.ts:3182

Rebuilds the element’s movie from cached assets. Everything composed into it is gone afterwards.

Returns

boolean

True when the element took it.

---

requestHide()

requestHide(): boolean

Defined in: client/api.d.ts:3176

Asks the element to play its own hide transition instead of vanishing.

Returns

boolean

True when the element took it.

---

setArray()

setArray(name, values): boolean

Defined in: client/api.d.ts:3127

Replaces one of the element’s declared arrays. This is how the game’s own list screens are filled.

Parameters

name

string

An array the element’s XML declares.

values

(string | number | boolean | null)[]

The new contents.

Returns

boolean

True when the movie accepted it.

---

setClip()

setClip(name, options): boolean

Defined in: client/api.d.ts:3142

Moves one of the element’s declared movie clips. Two of the game’s elements declare any: the HUD and the lockpicking screen.

Parameters

name

string

A movie clip the element’s XML declares.

options

Only the fields present are applied.

alpha?

number

rotation?

number

scaleX?

number

scaleY?

number

visible?

boolean

x?

number

y?

number

Returns

boolean

True when the movie accepted it.

---

setVariable()

setVariable(name, value): boolean

Defined in: client/api.d.ts:3112

Assigns one of the element’s declared variables.

Parameters

name

string

A variable the element’s XML declares.

value

string | number | boolean | null

What to assign.

Returns

boolean

True when the movie accepted it.

---

show()

show(): boolean

Defined in: client/api.d.ts:3164

Shows the element, loading its movie if it was not loaded.

Returns

boolean

True when the element took it.

---

toString()

toString(): string

Defined in: client/api.d.ts:3096

Formats this handle for logging.

Returns

string

---

unload()

unload(): boolean

Defined in: client/api.d.ts:3188

Drops the element’s movie. The next show loads it again.

Returns

boolean

True when the element took it.

Properties

instanceId

readonly instanceId: number

Defined in: client/api.d.ts:3081

Which instance this handle drives. Instance 0 is the one the game itself uses; any other number is a private copy of the same element.

---

name

readonly name: string

Defined in: client/api.d.ts:3076

The element’s name, as its XML declares it.

---

valid

readonly valid: boolean

Defined in: client/api.d.ts:3086

Whether the element is still registered.

---

visible

readonly visible: boolean

Defined in: client/api.d.ts:3091

Whether the element is visible right now.