Method Global:RegisterPacketEvent [-] [+]
Registers a WorldPacket 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 |
---|---|---|---|---|
5 | ON_PACKET_RECEIVE | WORLD | event, packet, player | Player only if accessible. Can return false, newPacket |
6 | ON_PACKET_RECEIVE_UNKNOWN | Not implemented | ||
7 | ON_PACKET_SEND | WORLD | event, packet, player | Player only if accessible. Can return false |
Synopsis
cancel = RegisterPacketEvent( entry, event, function )
cancel = RegisterPacketEvent( entry, event, function, shots )
Arguments
number entry
Opcode.
Valid numbers: integers from 0 to 4,294,967,295.
number event
Packet event Id, refer to table above.
Valid numbers: integers from 0 to 4,294,967,295.
function function
Function to register.
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 cancel
A function that cancels the binding when called.