V5 DocsAthenaClient.rmlui.commands ​
Modules ​
Functions ​
cancel ​
Usage
AthenaClient.rmlui.commands.cancel(): any
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:318
create ​
Usage
AthenaClient.rmlui.commands.create(inputInfo, skipMenuCheck?): Promise<string | undefined>
Parameters ​
| Name | Type | Default value |
|---|---|---|
inputInfo | CommandInput | undefined |
skipMenuCheck | boolean | false |
Returns ​
Promise<string | undefined>
Defined in ​
client/rmlui/commands/index.ts:284
isOpen ​
Usage
AthenaClient.rmlui.commands.isOpen(): boolean
Returns whether or not this interface is open.
Returns ​
boolean
Defined in ​
client/rmlui/commands/index.ts:353
override ​
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "autoFillCommand" |
callback | () => any |
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:386
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "browseHistory" |
callback | (shouldIncrease: boolean) => any |
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:387
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "cancel" |
callback | () => any |
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:388
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "create" |
callback | (inputInfo: CommandInput, skipMenuCheck: boolean) => Promise<string | undefined> |
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:389
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "focus" |
callback | (inputInfo: CommandInput) => any |
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:390
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "getCurrentMessage" |
callback | () => string |
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:391
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "handleKeyUp" |
callback | (keycode: number) => any |
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:392
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "handleMessageUpdate" |
callback | () => any |
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:393
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "isOpen" |
callback | () => boolean |
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:394
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "submit" |
callback | () => any |
Returns ​
any
Defined in ​
client/rmlui/commands/index.ts:395
Usage
AthenaClient.rmlui.commands.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "updateSuggestions" |
callback | (suggestions: Omit<MessageCommand<Player>, "callback">[]) => any |
Returns ​
any