This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eGetAutoTeamEvent
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
The bz_eGetAutoTeamEvent is an API event that is called for each new player is added to a team.
Data
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. |
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.