Method Global:RegisterServerEvent [-] [+]
Registers a server event handler.
In Multistate mode (default), events are either registered to the WORLD state (-1) or the MAP states (map ID). These events will only ever trigger on their respective state.
In Compatibility mode, all events are registered to the WORLD state (-1).
| ID | Event | State | Parameters | Comment |
|---|---|---|---|---|
| 1 | SERVER_EVENT_ON_NETWORK_START | Not Implemented | ||
| 2 | SERVER_EVENT_ON_NETWORK_STOP | Not Implemented | ||
| 3 | SERVER_EVENT_ON_SOCKET_OPEN | Not Implemented | ||
| 4 | SERVER_EVENT_ON_SOCKET_CLOSE | Not Implemented | ||
| 5 | SERVER_EVENT_ON_PACKET_RECEIVE | WORLD | event, packet, player | Player only if accessible. Can return false, newPacket |
| 6 | SERVER_EVENT_ON_PACKET_RECEIVE_UNKNOWN | Not Implemented | ||
| 7 | SERVER_EVENT_ON_PACKET_SEND | WORLD | event, packet, player | Player only if accessible. Can return false |
| 8 | WORLD_EVENT_ON_OPEN_STATE_CHANGE | WORLD | event, open | Needs core support on Mangos |
| 9 | WORLD_EVENT_ON_CONFIG_LOAD | WORLD | event, reload | |
| 11 | WORLD_EVENT_ON_SHUTDOWN_INIT | WORLD | event, code, mask | |
| 12 | WORLD_EVENT_ON_SHUTDOWN_CANCEL | WORLD | event | |
| 13 | WORLD_EVENT_ON_UPDATE | WORLD | event, diff | |
| 14 | WORLD_EVENT_ON_STARTUP | WORLD | event | |
| 15 | WORLD_EVENT_ON_SHUTDOWN | WORLD | event | |
| 16 | ELUNA_EVENT_ON_LUA_STATE_CLOSE | ALL | event | Triggers just before shutting down the Eluna state (on shutdown, restart and reload) |
| 17 | MAP_EVENT_ON_CREATE | MAP | event, map | |
| 18 | MAP_EVENT_ON_DESTROY | MAP | event, map | |
| 19 | MAP_EVENT_ON_GRID_LOAD | Not Implemented | ||
| 20 | MAP_EVENT_ON_GRID_UNLOAD | Not Implemented | ||
| 21 | MAP_EVENT_ON_PLAYER_ENTER | MAP | event, map, player | |
| 22 | MAP_EVENT_ON_PLAYER_LEAVE | MAP | event, map, player | |
| 23 | MAP_EVENT_ON_UPDATE | MAP | event, map, diff | |
| 24 | TRIGGER_EVENT_ON_TRIGGER | MAP | event, player, triggerId | Can return true |
| 25 | WEATHER_EVENT_ON_CHANGE | WORLD | event, zoneId, state, grade | |
| 26 | AUCTION_EVENT_ON_ADD | WORLD | event, auctionId, owner, item, expireTime, buyout, startBid, currentBid, bidderGUIDLow | |
| 27 | AUCTION_EVENT_ON_REMOVE | WORLD | event, auctionId, owner, item, expireTime, buyout, startBid, currentBid, bidderGUIDLow | |
| 28 | AUCTION_EVENT_ON_SUCCESSFUL | WORLD | event, auctionId, owner, item, expireTime, buyout, startBid, currentBid, bidderGUIDLow | |
| 29 | AUCTION_EVENT_ON_EXPIRE | WORLD | event, auctionId, owner, item, expireTime, buyout, startBid, currentBid, bidderGUIDLow | |
| 30 | ADDON_EVENT_ON_MESSAGE | WORLD | event, sender, type, prefix, msg, target | Target can be nil/whisper_target/guild/group/channel. Can return false |
| 31 | WORLD_EVENT_ON_DELETE_CREATURE | MAP | event, creature | |
| 32 | WORLD_EVENT_ON_DELETE_GAMEOBJECT | MAP | event, gameobject | |
| 33 | ELUNA_EVENT_ON_LUA_STATE_OPEN | ALL | event | Triggers after all scripts are loaded |
| 34 | GAME_EVENT_START | WORLD | event, gameeventid | |
| 35 | GAME_EVENT_STOP | WORLD | event, gameeventid |
Synopsis
cancel = RegisterServerEvent( event, function )
cancel = RegisterServerEvent( event, function, shots )
Arguments
number eventServer event ID, refer to table above.
Valid numbers: integers from 0 to 4,294,967,295.
function functionFunction that will be called when the event occurs.
number shots (0)The number of times the function will be called, 0 means "always call this function".
Valid numbers: integers from 0 to 4,294,967,295.
Returns
function cancelA function that cancels the binding when called.