Difference between revisions of "Bz eGetAutoTeamEvent"

From BZFlagWiki
Jump to: navigation, search
m (fixed typo)
(added eventTime)
 
Line 32: Line 32:
 
   |bool
 
   |bool
 
   |The current state representing if other plug-ins have modified the default team. Plug-ins that modify the team should set this value to true to inform other plug-ins that have not processed yet.
 
   |The current state representing if other plug-ins have modified the default team. Plug-ins that modify the team should set this value to true to inform other plug-ins that have not processed yet.
 +
  |-
 +
  |eventTime
 +
  |double
 +
  |The server time at which the event occurred (in seconds).
 
   |}
 
   |}
  
 
==Uses==
 
==Uses==
 
This is a modification event, the final results of the team member will be used and sent to the requesting player. Please note that this event can override the user's team choice.
 
This is a modification event, the final results of the team member will be used and sent to the requesting player. Please note that this event can override the user's team choice.

Latest revision as of 07:47, 1 May 2014

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_eGetAutoTeamEvent is an API event that is called for each new player is added to a team.

Data[edit]

bz_eGetAutoTeamEvent returns the bz_GetAutoTeamEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eGetAutoTeamEvent
playerID int ID of the player that is being added to the game.
callsign bz_ApiString Callsign of the player that is being added to the game.
team bz_eTeamType The team that the player will be added to. Initialized to the team chosen by the current server team rules, or the effects of a plug-in that has previously processed the event. Plug-ins wishing to override the team should set this value.
handled bool The current state representing if other plug-ins have modified the default team. Plug-ins that modify the team should set this value to true to inform other plug-ins that have not processed yet.
eventTime double The server time at which the event occurred (in seconds).

Uses[edit]

This is a modification event, the final results of the team member will be used and sent to the requesting player. Please note that this event can override the user's team choice.