Hierarchy

  • ClientEvents

Properties

app-suspended: LatiteEvent

Called on the game being minimized/closed.

change-dimension: LatiteEvent

Calls whenever the player goes into a different dimension.

click: ClickEvent

Called on every (non-move) mouse input. Cancellable - setting cancel to true will make the game not see the event.

Listener:

{
button: MouseButton,
isDown: boolean,
mouseX: number,
mouseY: number,
cancel: boolean
}
join-game: LatiteEvent
key-press: KeyEvent

Called on every keyboard input. Cancellable - setting cancel to true will make the game not see the event.

Listener:

{
isDown: boolean,
keyCode: KeyCode,
keyAsChar: string,
cancel: boolean
}
leave-game: LatiteEvent

Called on the user leaving a world.

load-script: ScriptEvent

Called on any script being loaded.

Listener:

{
scriptName: string,
scriptVersion: string,
scriptAuthor: string
}
receive-chat: MessageEvent<any>

Called on every message received.

Listener:

{
type: MessageType;
isChat: boolean;
message: string;
sender: string;
xuid: string;
}
render2d: LatiteEvent

Called on every frame; use this for 2D rendering.

render3d: LatiteEvent

Called on every frame; use this for 3D rendering.

renderDX: LatiteEvent

Called on every frame; use this for DirectX rendering.

send-chat: SendChatEvent

Called on every chat message sent. Cancellable - setting cancel to true will make the game not see the event.

Listener:

{
message: string,
cancel: boolean
}
text-input: TextInputEvent

Called whenever text input is received.

Listener:
{
characters: string
}
title: TitleEvent

Called whenever you receive a title from the server.

Listener:

{
type: TitleType,
text: string
}
transfer: LatiteEvent

Called whenever the server transfers a player into another server.

unload-script: ScriptEvent

Called on any script being unloaded.

Listener:

{
scriptName: string,
scriptVersion: string,
scriptAuthor: string
}
world-tick: LatiteEvent

Called on every tick.

Generated using TypeDoc