This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.
bz ePlayerPartEvent
| BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server. |
BZFS Event. This page documents a BZFS event that is called by the game server to notify plug-ins of various actions and state changes in the game world.
Overview
The bz_ePlayerPartEvent is an API event that is called each time a player parts (ie, leaves) a game.
Data
bz_ePlayerPartEvent returns the bz_PlayerJoinPartEventData_V1 data class. The event data record is shared between both join and part events.
| name | type | value description |
|---|---|---|
| eventType | bz_eEventType | bz_ePlayerPartEvent |
| playerID | int | The player ID that is leaving |
| record | bz_BasePlayerRecord * | The player record for the leaving player |
| reason | bzApiString | The reason for the event, for example, why a player has been kicked |
| eventTime | double | Time of event. |
Uses
This event is a notification only event, none of the data returned can be changed.