Skip to content

GameEvent

GameEvent = { monMapId: number; type: "monsterDeath"; } | { itemId: number; name: string; quantity: number; type: "itemDrop"; } | { afk: boolean; self: boolean; type: "afk"; username: string; } | { type: "zone"; zone: string; } | { map: string; type: "mapJoined"; } | { cell: string; pad: string; self: boolean; type: "cellChanged"; username: string; } | { self: boolean; type: "playerJoined"; username: string; } | { self: boolean; type: "playerLeft"; username: string; } | { type: "logout"; } | { self: boolean; state: State; type: "playerState"; username: string; } | { monMapId: number; type: "monsterRespawn"; } | { duration: number | null; name: string; self: boolean; targetId: number; targetType: "monster" | "player"; type: "auraAdded"; } | { name: string; self: boolean; targetId: number; targetType: "monster" | "player"; type: "auraRemoved"; } | { monMapId: number | null; text: string; type: "message"; } | { itemId: number; name: string; quantity: number; temp: boolean; type: "itemAdded"; } | { name: string; questId: number; type: "questCompleted"; }

{ monMapId: number; type: "monsterDeath"; }


{ itemId: number; name: string; quantity: number; type: "itemDrop"; }

readonly itemId: number

readonly name: string

readonly quantity: number

The amount in this drop.

readonly type: "itemDrop"


{ afk: boolean; self: boolean; type: "afk"; username: string; }

A player went AFK or came back. self is you.


{ type: "zone"; zone: string; }

"" is the map’s default zone.


{ map: string; type: "mapJoined"; }


{ cell: string; pad: string; self: boolean; type: "cellChanged"; username: string; }

A player jumped to a cell. Walking within a cell doesn’t count.


{ self: boolean; type: "playerJoined"; username: string; }

Another player entered the room.


{ self: boolean; type: "playerLeft"; username: string; }


{ type: "logout"; }

The connection to the server dropped.


{ self: boolean; state: State; type: "playerState"; username: string; }

"dead" is a death. "idle" is a respawn or leaving combat.


{ monMapId: number; type: "monsterRespawn"; }


{ duration: number | null; name: string; self: boolean; targetId: number; targetType: "monster" | "player"; type: "auraAdded"; }

targetId is a monster’s monMapId or a player’s userId.

readonly duration: number | null

Seconds.

readonly name: string

readonly self: boolean

readonly targetId: number

readonly targetType: "monster" | "player"

readonly type: "auraAdded"


{ name: string; self: boolean; targetId: number; targetType: "monster" | "player"; type: "auraRemoved"; }


{ monMapId: number | null; text: string; type: "message"; }

A line a monster says, or a message the server shows you.


{ itemId: number; name: string; quantity: number; temp: boolean; type: "itemAdded"; }

An item went straight into your inventory, such as a quest reward or a temporary item.


{ name: string; questId: number; type: "questCompleted"; }

The server accepted a turn-in, whether from a script or the game’s quest window.