This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.
Bz ePlayerSpawnEvent: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{BZFS_API_Doc}} | {{BZFS_API_Doc}} | ||
{{BZFS_API_Events}} | {{BZFS_API_Events}} | ||
==Overview== | ==Overview== | ||
The '''bz_ePlayerSpawnEvent''' is an API event that is called each time a | The '''bz_ePlayerSpawnEvent''' is an API event that is called each time a playing tank is being spawned into the world. | ||
==Data== | ==Data== | ||
'''bz_ePlayerSpawnEvent''' returns the ''' | '''bz_ePlayerSpawnEvent''' returns the '''bz_PlayerSpawnEventData_V1''' data class. | ||
{| border="1" cellpadding="20" cellspacing="0" | {| border="1" cellpadding="20" cellspacing="0" | ||
| Line 20: | Line 19: | ||
|playerID | |playerID | ||
|int | |int | ||
|ID of the player who | |ID of the player who was added to the world. | ||
|- | |- | ||
|team | |team | ||
|bz_eTeamType | |[[bz_eTeamType]] | ||
|The team the | |The team the player is a member of. | ||
|- | |- | ||
| | |state | ||
| | |[[bz_PlayerUpdateState]] | ||
| | |The state record for the spawning player | ||
|- | |- | ||
| | |eventTime | ||
|double | |double | ||
|Time | |Time local server time for the event. | ||
|} | |} | ||
Revision as of 18:11, 28 November 2007
| 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_ePlayerSpawnEvent is an API event that is called each time a playing tank is being spawned into the world.
Data
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
This event is a notification only event, none of the data returned can be changed.