This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eAllowSpawn
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_eAllowSpawn is an API event called before a player respawns.
Data[edit]
bz_eAllowSpawn returns the bz_AllowSpawnData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_eAllowSpawn |
playerID | int | The ID of the player that will spawn. |
team | bz_eTeamType | The team the player belongs to. |
handled | bool | |
allow | bool | Set to false if the player should not be allowed to spawn. |
eventTime | double | The server time the event occurred (in seconds.) |