Latite Scripting Documentation (Exports)
Interface
Source: latite.d.ts:249
readonlyversion:string
The Latite Client version. Example: "v2.0.0"
Source: latite.d.ts:284
getCommandManager():
CommandManager
Gets the command manager. Use this to register commands.
Source: latite.d.ts:279
getModuleManager():
ModuleManager
Gets the module manager. Use this to register modules.
Source: latite.d.ts:274
on<K>( eventName:
K, listener:Function, priority?:number):void
Listens to a client-side event.
Source: latite.d.ts:256
| Parameter |
|---|
K extends keyof ClientEvents |
| Parameter | Type | Description |
|---|---|---|
| eventName | K |
The event to listen to |
| listener | (event: ClientEvents[K]) => void |
The event callback |
| priority? | number |
Positive or negative integer. The priority in which the event listener should have over other events globally. The default is 0. Greater = called first, less = called later. |
void
runCommand(cmd:
string):boolean
Runs a Latite command.
Source: latite.d.ts:269
| Parameter | Type | Description |
|---|---|---|
| cmd | string |
The command to run. Do not add the prefix (.) |
boolean
The success of the command.
showNotification(notif:
string):void
Shows a Latite toast on the top of the screen.
Source: latite.d.ts:262
| Parameter | Type | Description |
|---|---|---|
| notif | string |
The notification to show. |
void