Skip to content

interface.ClientEvents.md

Latest commit

 

History

History
242 lines (146 loc) · 5.95 KB

interface.ClientEvents.md

File metadata and controls

242 lines (146 loc) · 5.95 KB

Latite Scripting Documentation (Exports)

Exports > latite > ClientEvents

ClientEvents

Interface

Source: latite.d.ts:90

Properties

app-suspended

app-suspended: LatiteEvent

Called on the game being minimized/closed.

Source: latite.d.ts:175

change-dimension

change-dimension: LatiteEvent

Calls whenever the player goes into a different dimension.

Source: latite.d.ts:236

click

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
}

Source: latite.d.ts:167

join-game

join-game: LatiteEvent

Source: latite.d.ts:98

key-press

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
}

Source: latite.d.ts:152

leave-game

leave-game: LatiteEvent

Called on the user leaving a world.

Source: latite.d.ts:103

load-script

load-script: ScriptEvent

Called on any script being loaded.

Listener:

{
  scriptName: string,
  scriptVersion: string,
  scriptAuthor: string
}

Source: latite.d.ts:188

post-move

post-move: LatiteEvent

Called after movement input is processed.

Source: latite.d.ts:246

pre-move

pre-move: CancellableEvent

Called before movement input is processed. This is cancellable.

Source: latite.d.ts:241

receive-chat

receive-chat: MessageEvent<any>

Called on every message received.

Listener:

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

Source: latite.d.ts:118

render2d

render2d: LatiteEvent

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

Source: latite.d.ts:134

render3d

render3d: LatiteEvent

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

Source: latite.d.ts:171

renderDX

renderDX: LatiteEvent

Called on every frame; use this for DirectX rendering.

Source: latite.d.ts:138

send-chat

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
}

Source: latite.d.ts:130

text-input

text-input: TextInputEvent

Called whenever text input is received.

Listener: {
  characters: string;
}

Source: latite.d.ts:226

title

title: TitleEvent

Called whenever you receive a title from the server.

Listener:

{
  type: TitleType,
  text: string
}

Source: latite.d.ts:214

transfer

transfer: LatiteEvent

Called whenever the server transfers a player into another server.

Source: latite.d.ts:231

unload-script

unload-script: ScriptEvent

Called on any script being unloaded.

Listener:

{
  scriptName: string,
  scriptVersion: string,
  scriptAuthor: string
}

Source: latite.d.ts:201

world-tick

world-tick: LatiteEvent

Called on every tick.

Source: latite.d.ts:94