bz ePlayerTeamChangeEvent

From BZFlagWiki
Revision as of 18:44, 25 September 2010 by Mrapple (Talk | contribs) (bz_ePlayerTeamChangeEvent)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
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_ePlayerTeamChangeEvent is an API event that is called each time a player switches teams via bz_changeTeam().

Data[edit]

bz_ePlayerTeamChangeEvent returns the bz_PlayerTeamChangeData_V1 data class.

name type value description
eventType bz_eEventType bz_ePlayerTeamChangeEvent
playerID int ID of the player whos team was switched
oldTeam bz_eTeamType The team the player used to be on
newTeam bz_eTeamType The new team the player is on

Usagae[edit]

Data returned can not be modified.