bz_ePlayerPartEvent
This event is called each time a player leaves a game
Data Object Type
2.4.0 bz_PlayerJoinPartEventData_V1
Parameters
These are the values accessible in the bz_EventData
variable that's made available in the Event
method.
Data Type | Name | Description |
---|---|---|
int |
playerID
|
The player ID that is leaving |
bz_BasePlayerRecord* |
record
|
The player record for the leaving player |
bz_ApiString |
reason
|
The reason for leaving, such as a kick or a ban |
double |
eventTime
|
Time of event. |
Plug-in Usage
Here's a list of plug-ins part of the official distribution that makes use of this event:
- HoldTheFlag
- Phoenix
- fairCTF
- keepaway
- koth
- logDetail
- nagware
- playHistoryTracker
- pushstats
- rabbitTimer
- regFlag
- serverControl
Plug-in Example
This block of code can be used to get started when implementing the Event()
function of your plug-in.
bz_PlayerJoinPartEventData_V1* dataObject = (bz_PlayerJoinPartEventData_V1*)eventData;
// Data
// ---
// (int) playerID - The player ID that is leaving
// (bz_BasePlayerRecord*) record - The player record for the leaving player
// (bz_ApiString) reason - The reason for leaving, such as a kick or a ban
// (double) eventTime - Time of event.
Other Player Events
This content is maintained on GitHub. We welcome any feedback and improvements!