This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eGetAutoTeamEvent
From BZFlagWiki
Revision as of 16:46, 28 November 2007 by Tulcod (Talk | contribs) (New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eGetAutoTeamEvent''' is an API event that is called when the server needs to know which team to add a new player to. ==Data== ...)
| 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 when the server needs to know which team to add a new player to.
Data
bz_eGetAutoTeamEvent returns the bz_GetAutoTeamEventData_V1 data class.
| name | type | value description |
|---|---|---|
| eventType | bz_eEventType | bz_eGetAutoTeamEvent |
| playerID | int | ID of the new player |
| callsign | bzApiString | Callsign of the new player |
| team | bz_eTeamType | The team bzfs chose the player to belong to, you CAN change this |
| handled | bool | Set this value to true once you've modified the team, so that other plugins will know they shouldn't modify it again |
Uses
You can use this event to let team choosing be done by a plugin.
