This wiki is archived and useful information is being migrated to the main bzflag.org website
bz ePlayerJoinEvent
From BZFlagWiki
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[edit]
The bz_ePlayerJoinEvent is an API event that is called each time a player joins the game.
Data[edit]
bz_ePlayerJoinEvent 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_ePlayerJoinEvent |
playerID | int | The player ID that is joining |
record | bz_BasePlayerRecord * | The player record for the joining player |
reason | bz_ApiString | The reason for the event, unused for join events |
eventTime | double | Time of event. |
Uses[edit]
This event is a notification-only event, none of the data returned can be changed.