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
The bz_ePlayerJoinEvent is an API event that is called each time a player joins the game.
Data
bz_ePlayerJoinEvent returns the bz_PlayerJoinPartEventData data class.
name | type | value desription |
---|---|---|
eventType | bz_eEventType | bz_eFlagDroppedEvent |
playerID | int | The player that dropped the flag |
team | bz_eTeamType | The team the new player is a member of |
callsign | bzApiString | Callsign of the player |
bzApiString | Email string of the player | |
verified | bool | This flag is true if a player has identified as a registered user. |
globalUser | bzApiString | Registered username of the player |
ipAddress | bzApiString | IP address of the player |
reason | bzApiString | Not used for join events |
time | double | Time of join |
Uses
This event is a notification only event, none of the data returned can be changed.