Bz eGetAutoTeamEvent - Revision history

Zehra: redirect, since events are in official docs

2025-11-09T22:13:39Z

redirect, since events are in official docs

← Older revision		Revision as of 22:13, 9 November 2025
Line 1:		Line 1:
	~~{{BZFS_API_Doc}}~~		#REDIRECT [[Category:BZFS API Docs]]
	~~{{BZFS_API_Events}}~~

	~~==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.~~

	~~{\| border="1" cellpadding="20" cellspacing="0"~~
	~~!name~~
	~~!type~~
	~~!value description~~
	\|-
	~~\|eventType~~
	\|[[~~Event(~~API~~)\|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==~~
	~~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.~~

Allejo: added eventTime

2014-05-01T07:47:54Z

added eventTime

← Older revision		Revision as of 07:47, 1 May 2014
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.

Allejo: fixed typo

2013-12-23T01:13:21Z

fixed typo

← Older revision		Revision as of 01:13, 23 December 2013
Line 27:		Line 27:
	\|team		\|team
	\|[[bz_eTeamType]]		\|[[bz_eTeamType]]
	\|The team that the player will be added to. ~~Initalised~~ 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.		\|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		\|handled

72.67.85.156: /* Uses */

2008-08-26T23:35:40Z

Uses

← Older revision		Revision as of 23:35, 26 August 2008
Line 35:		Line 35:

	==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 ~~users~~ 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.

JeffM2501 at 18:07, 28 November 2007

2007-11-28T18:07:07Z

← Older revision		Revision as of 18:07, 28 November 2007
Line 3:		Line 3:

	==Overview==		==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.		The '''bz_eGetAutoTeamEvent''' is an API event that is called for each new player is added to a team.

	==Data==		==Data==
Line 19:		Line 19:
	\|playerID		\|playerID
	\|int		\|int
	\|ID of the ~~new~~ player		\|ID of the player that is being added to the game.
	\|-		\|-
	\|callsign		\|callsign
	\|~~bzApiString~~		\|[[bz_ApiString]]
	\|Callsign of the ~~new~~ player		\|Callsign of the player that is being added to the game.
	\|-		\|-
	\|team		\|team
	\|bz_eTeamType		\|[[bz_eTeamType]]
	\|The team ~~bzfs chose~~ the player to ~~belong~~ to, ~~you CAN change~~ this		\|The team that the player will be added to. Initalised 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		\|handled
	\|bool		\|bool
	\|~~Set~~ this value to true ~~once you've modified the team, so~~ that ~~other plugins will know they shouldn't modify it again~~		\|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==		==Uses==
	~~You can use~~ this event ~~to let~~ team ~~choosing be done by a plugin~~.		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 users team choice.

	~~[[Category:BZFS_API_Docs]]~~
	~~[[Category:BZFS_API_Events]]~~

Tulcod: 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== ...

2007-11-28T16:46:10Z

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== ...

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==
'''bz_eGetAutoTeamEvent''' returns the '''bz_GetAutoTeamEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|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.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]