Athena.player.events ​

Type Aliases ​

AthenaPlayerEvents ​

Ƭ AthenaPlayerEvents: "drop-item" | "increased-play-time" | "item-equipped" | "item-unequipped" | "pickup-item" | "player-account-created" | "player-character-created" | "player-armour-set" | "player-died" | "player-disconnected" | "player-entered-vehicle-as-driver" | "player-health-set" | "player-left-vehicle-seat" | "player-pos-set" | "player-skin-cleared" | "player-skin-set" | "player-uniform-cleared" | "player-uniform-set" | "player-weapon-unequipped" | "respawned" | "selected-character" | "set-account-data" | "spawned"

Defined in ​

server/player/events.ts:6

Functions ​

on ​

Called when a player item has changed from unequipped to equipped.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:68

Called when a player item has changed to unequipped

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:80

Called when a player has died.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:92

Called when a player uniform has been set. Check characterDocument.data

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:102

Called when a player uniform has been cleared. Uniform is set to undefined / null

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:112

Called when a player has their model set to non-multiplayer models.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:121

Called when a player has their model cleared to a multiplayer model.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:130

Called when the internal safe health functions are invoked. This is never called when player.health is modified

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:140

Called when the internal safe armour functions are invoked. This is never called when player.armour is modified.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:150

Called when the internal safe position functions are invoked. This is never called when player.pos is modified.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:160

Called when playtime has increased slightly.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:169

Called when a player has dropped an item.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:178

Called when a player picks up an item. The _id is a reference to the item in the database; or the item in the ItemDrops system.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:188

Called when a player selects a character

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:197

Called when a player has been respawned by internal functions.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:206

Called when a player has left a vehicle seat.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:215

Called when a player enters a vehicle as a driver.

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:227

Triggers when a player id is unbound from a document. Formally known as a disconnect event. PLAYER WILL BE UNDEFINED, DO NOT USE VARIABLE

Type parameters ​

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:242

Triggers when a player unequips a weapon.

Type parameters ​

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:252

Called when a new account is created.

This means a new account is now bound to a new player.

Any additional document changes with this event will need to handled through the Athena.document.account system.

Type parameters ​

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:269

Called when a new character is created.

This means a new character is now bound to a player.

Any additional document changes with this event will need to handled through the Athena.document.player system.

Type parameters ​

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:283

Called when a player has set their account data.

Called immediately after authentication.

Export

Type parameters ​

Parameters ​

Returns ​

any

Defined in ​

server/player/events.ts:295

trigger ​

Usually called by internal functions. Can be used to manually trigger an Athena Event though.

Type parameters ​

Parameters ​

Returns ​

void

Defined in ​

server/player/events.ts:43