This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Bz ePlayerSpawnEvent"

From BZFlagWiki
Jump to: navigation, search
(Uses: hyphenated compound adjective)
 
(2 intermediate revisions by one other user not shown)
Line 3: Line 3:
  
 
==Overview==
 
==Overview==
The '''bz_ePlayerSpawnEvent''' is an API event that is called each time a player spawns in the world, either after joining or after being killed.
+
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_PlayerSpawnEventData''' data class.
+
'''bz_ePlayerSpawnEvent''' returns the '''bz_PlayerSpawnEventData_V1''' data class.
  
 
   {| border="1" cellpadding="20" cellspacing="0"
 
   {| border="1" cellpadding="20" cellspacing="0"
Line 19: Line 19:
 
   |playerID
 
   |playerID
 
   |int
 
   |int
   |ID of the player who spawned
+
   |ID of the player who was added to the world.
 
   |-
 
   |-
 
   |team
 
   |team
   |bz_eTeamType
+
   |[[bz_eTeamType]]
   |The team the spawning player is a member of
+
   |The team the player is a member of.
 
   |-
 
   |-
   |pos
+
   |state
   |float[3]
+
   |[[bz_PlayerUpdateState]]
   |Position of the spawning player
+
   |The state record for the spawning player
 
   |-
 
   |-
   |rot
+
   |eventTime
  |float
+
  |Rotation of the spawning player
+
  |-
+
  |time
+
 
   |double
 
   |double
   |Time at which the player spawned
+
   |Time local server time for the event.
 
   |}
 
   |}
  
 
==Uses==
 
==Uses==
This event is a notification only event, none of the data returned can be changed.
+
This event is a notification-only event, none of the data returned can be changed.
  
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Events]]
 
[[Category:BZFS_API_Events]]

Latest revision as of 23:30, 27 January 2013

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.