This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eAllowPlayer
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_eAllowPlayer is an API event that is called each time a player connects to the server. This event is called after all internal allow/deny logic.
Data[edit]
bz_eAllowPlayer returns the bz_AllowPlayerEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eAllowPlayer |
playerID | int | This value is the player ID for the joining player. |
callsign | bz_ApiString | This value is the callsign for the player. |
ipAddress | bz_ApiString | This value is the IPv4 address of the player. |
reason | bz_ApiString | This value is the reason for any denials of admittance, it will be reported back to the player. |
allow | bool | This value is the current allow/deny state for the join. Plug-ins wishing to overide the server allow/deny logic can change this value. |
eventTime | double | This value is the local server time of the event. |
Uses[edit]
This is a modification event, plug-ins may override the allow/deny logic choice themselves. This is the primary hook for plug-ins that wish to implement custom ban list systems.