EventMap
Defined in: server/api.d.ts:1571
Native events dispatched through Events.on. Each property is the exact callback argument tuple for that event.
Properties
Section titled “Properties”actionPointHit
Section titled “actionPointHit”actionPointHit: [
ActionPoint,Player]
Defined in: server/api.d.ts:1695
Dispatched when a player activates a replicated action point.
consoleCommand
Section titled “consoleCommand”consoleCommand: [
string,string[]]
Defined in: server/api.d.ts:1585
Dispatched after the server console parses a command line that is not handled by a built-in command.
jukeboxUse
Section titled “jukeboxUse”jukeboxUse: [
Player,number]
Defined in: server/api.d.ts:1690
Dispatched when a player uses a synchronized jukebox.
markerHit
Section titled “markerHit”Defined in: server/api.d.ts:1700
Dispatched when a player enters a marker’s trigger radius.
markerLeave
Section titled “markerLeave”Defined in: server/api.d.ts:1705
Dispatched when a player leaves a marker’s trigger radius.
npcDeath
Section titled “npcDeath”npcDeath: [
Npc,Player|null,NpcDeathInfo]
Defined in: server/api.d.ts:1625
Dispatched when a server-driven NPC dies, whether from a player’s hit or from npc.kill().
playerChat
Section titled “playerChat”playerChat: [
Player,string]
Defined in: server/api.d.ts:1640
Dispatched when a player submits a chat message.
playerCommand
Section titled “playerCommand”playerCommand: [
Player,string,string[]]
Defined in: server/api.d.ts:1645
Dispatched when a player’s chat input is parsed as a command.
playerConnect
Section titled “playerConnect”playerConnect: [
Player]
Defined in: server/api.d.ts:1590
Dispatched after an M2O player is connected and its script handle can be resolved.
playerDamage
Section titled “playerDamage”playerDamage: [
Player,PlayerDamageInfo]
Defined in: server/api.d.ts:1630
Dispatched when the server relays a bullet hit the shooter resolved against a player. Fires before the victim applies it, so the resulting health arrives with that player’s next sync.
playerDeath
Section titled “playerDeath”playerDeath: [
Player,Player|null,PlayerDeathInfo]
Defined in: server/api.d.ts:1620
Dispatched after the server receives and resolves a player’s death report.
playerDialNumber
Section titled “playerDialNumber”playerDialNumber: [
Player,number,string,number]
Defined in: server/api.d.ts:1685
Dispatched after a player dials a registered phone-book number.
playerDisconnect
Section titled “playerDisconnect”playerDisconnect: [
Player]
Defined in: server/api.d.ts:1595
Dispatched when an M2O player disconnects.
playerShopBuy
Section titled “playerShopBuy”playerShopBuy: [
Player,string,number,number,number,boolean,string]
Defined in: server/api.d.ts:1680
Dispatched after a player buys an item from a native shop; price is expressed in currency units.
playerShopClose
Section titled “playerShopClose”playerShopClose: [
Player,string,number,string]
Defined in: server/api.d.ts:1675
Dispatched when a player closes a native shop.
playerShopEnter
Section titled “playerShopEnter”playerShopEnter: [
Player,string,string,boolean,string]
Defined in: server/api.d.ts:1665
Dispatched when a player triggers a city shop, whether or not the native menu came up. nativeOpened is false when a client shopOpen handler suppressed the menu or the game refused the open; source is "walkIn" or "script".
playerShopOpen
Section titled “playerShopOpen”playerShopOpen: [
Player,string,string]
Defined in: server/api.d.ts:1670
Dispatched when a player opens a native shop. shopName is the friendly shopmenu2 configuration name, which is what the client’s Shop.open and this side’s Shop.setItem take; shopPath is the internal shop script path.
playerSpawn
Section titled “playerSpawn”playerSpawn: [
Player]
Defined in: server/api.d.ts:1600
Dispatched after an M2O player spawns or respawns.
playerSubmerged
Section titled “playerSubmerged”Defined in: server/api.d.ts:1635
Dispatched when a player goes underwater and the game’s drowning sequence starts (it resurfaces them on the nearest shore). vehicle is the one they went under in, or null on foot.
playerWaypointCleared
Section titled “playerWaypointCleared”playerWaypointCleared: [
Player,number,number]
Defined in: server/api.d.ts:1660
Dispatched when a player clears the active GPS waypoint.
playerWaypointReached
Section titled “playerWaypointReached”playerWaypointReached: [
Player,number,number]
Defined in: server/api.d.ts:1655
Dispatched when a player reaches the active GPS waypoint.
playerWaypointSet
Section titled “playerWaypointSet”playerWaypointSet: [
Player,number,number]
Defined in: server/api.d.ts:1650
Dispatched when a player places a GPS waypoint.
playerWeaponFire
Section titled “playerWeaponFire”Defined in: server/api.d.ts:1610
Dispatched when the server receives a weapon-fire report from a player.
playerWeaponSwitch
Section titled “playerWeaponSwitch”playerWeaponSwitch: [
Player,number,number]
Defined in: server/api.d.ts:1605
Dispatched after the server receives the player’s authoritative weapon-switch update.
playerWeaponThrow
Section titled “playerWeaponThrow”Defined in: server/api.d.ts:1615
Dispatched when a player releases a grenade or Molotov.
resourceStart
Section titled “resourceStart”resourceStart: [
string]
Defined in: server/api.d.ts:1575
Dispatched after a resource entry point has run and immediately before the resource becomes running.
resourceStop
Section titled “resourceStop”resourceStop: [
string]
Defined in: server/api.d.ts:1580
Dispatched while a resource is stopping, before its stop callback, timers, exports, and event handlers are cleaned up.
vehicleDestroy
Section titled “vehicleDestroy”vehicleDestroy: [
Vehicle]
Defined in: server/api.d.ts:1715
Dispatched immediately before or while a replicated vehicle is destroyed.
vehicleExplode
Section titled “vehicleExplode”Defined in: server/api.d.ts:1720
Dispatched when a replicated vehicle explodes.
vehiclePlayerEntered
Section titled “vehiclePlayerEntered”Defined in: server/api.d.ts:1745
Dispatched after a player has entered a vehicle.
vehiclePlayerEntering
Section titled “vehiclePlayerEntering”Defined in: server/api.d.ts:1740
Dispatched when a player begins entering a vehicle seat.
vehiclePlayerExited
Section titled “vehiclePlayerExited”Defined in: server/api.d.ts:1755
Dispatched after a player has exited a vehicle.
vehiclePlayerExiting
Section titled “vehiclePlayerExiting”Defined in: server/api.d.ts:1750
Dispatched when a player begins exiting a vehicle.
vehicleRadioChange
Section titled “vehicleRadioChange”Defined in: server/api.d.ts:1735
Dispatched after a vehicle driver changes its radio station.
vehicleSpawn
Section titled “vehicleSpawn”vehicleSpawn: [
Vehicle]
Defined in: server/api.d.ts:1710
Dispatched immediately after a replicated vehicle is created.
vehicleSubmerged
Section titled “vehicleSubmerged”vehicleSubmerged: [
Vehicle]
Defined in: server/api.d.ts:1725
Dispatched when a replicated vehicle goes underwater.
vehicleSurfaced
Section titled “vehicleSurfaced”vehicleSurfaced: [
Vehicle]
Defined in: server/api.d.ts:1730
Dispatched when a previously submerged replicated vehicle leaves the water.