Skip to content
On this page

AthenaClient.rmlui.menu

Functions

close

Usage

AthenaClient.rmlui.menu.close(): Promise<void>

Call this function to close the menu. Make sure to wait for it to close before opening a new menu.

Returns

Promise<void>

Defined in

client/rmlui/menu/index.ts:435


create

Usage

AthenaClient.rmlui.menu.create(info): void

Create a menu similar to NativeUI.

Parameters

NameType
infoMenuInfo

Returns

void

Defined in

client/rmlui/menu/index.ts:405


createOption

Usage

AthenaClient.rmlui.menu.createOption<T>(menuTemplate): T

Build a menu option, and return the result. Used like: createOption<Range>({ ... });

Type parameters

NameType
TSelection | Range | Toggle | Invoke

Parameters

NameType
menuTemplateT

Returns

T

Defined in

client/rmlui/menu/index.ts:456


pauseControls

Usage

AthenaClient.rmlui.menu.pauseControls(): void

Returns

void

Defined in

client/rmlui/menu/index.ts:440


unpauseControls

Usage

AthenaClient.rmlui.menu.unpauseControls(): void

Returns

void

Defined in

client/rmlui/menu/index.ts:444

Created by Stuyk | Est. 2020