This wiki is archived and useful information is being migrated to the main bzflag.org website
bz ePlayerSpawnEvent
From BZFlagWiki
Revision as of 23:30, 27 January 2013 by Khonkhortisan (Talk | contribs) (→Uses: hyphenated compound adjective)
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_ePlayerSpawnEvent is an API event that is called each time a playing tank is being spawned into the world.
Data[edit]
bz_ePlayerSpawnEvent returns the bz_PlayerSpawnEventData_V1 data class.
name | type | value description |
---|---|---|
eventType | bz_eEventType | bz_ePlayerSpawnEvent |
playerID | int | ID of the player who was added to the world. |
team | bz_eTeamType | The team the player is a member of. |
state | bz_PlayerUpdateState | The state record for the spawning player |
eventTime | double | Time local server time for the event. |
Uses[edit]
This event is a notification-only event, none of the data returned can be changed.