AthenaClient.systems.messenger ​

Type Aliases ​

HistoryCallback ​

Ƭ HistoryCallback: (msgs: MessageInfo[]) => void

Type declaration ​

Parameters ​

Returns ​

void

Defined in ​

client/systems/messenger.ts:9

MessageCallback ​

Ƭ MessageCallback: (msg: string) => void

Type declaration ​

Parameters ​

Returns ​

void

Defined in ​

client/systems/messenger.ts:8

MessageInfo ​

Ƭ MessageInfo: Object

Type declaration ​

Defined in ​

client/systems/messenger.ts:7

Functions ​

emit ​

Emits a message to all callbacks.

Parameters ​

Returns ​

void

Defined in ​

client/systems/messenger.ts:43

getCommands ​

Get the commands that this client has permission for.

Returns ​

Omit<player<alt.Player>, "callback">[]

Defined in ​

client/systems/messenger.ts:101

getHistory ​

Return current chat history. Newest message is always first element in array.

Returns ​

{ msg: string ; timestamp: number }[]

Defined in ​

client/systems/messenger.ts:71

registerHistoryCallback ​

Register a callback that handles messages. The messages from other clients, and Athena itself will be pushed through all callbacks registered. Useful for plugin creators.

Parameters ​

Returns ​

void

Defined in ​

client/systems/messenger.ts:34

registerMessageCallback ​

Register a callback that handles messages. The messages from other clients, and Athena itself will be pushed through all callbacks registered. Useful for plugin creators.

Parameters ​

Returns ​

void

Defined in ​

client/systems/messenger.ts:23

send ​

Takes a message, or command and processes it from an input. Commands must start with a forward slash. Such as '/'.

Parameters ​

Returns ​

void

Defined in ​

client/systems/messenger.ts:81

setCommands ​

Populates the local command list for the client. Which can be used to

Parameters ​

Returns ​

void

Defined in ​

client/systems/messenger.ts:91