Player SetTeam: Difference between revisions

Latest revision as of 02:19, 3 July 2022

This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports.

145:Player_SetTeam (int team[, bool nobroadcast])

Usage

Changes the team of the player who activated the special to team. A valid team is anywhere between 0 and sv_maxteams (so 2, 3, 4). The teams are 0 = Blue, 1 = Red, 2 = Green, 3 = Gold. Using the current value of sv_maxteams removes the player from their current team without making them join another.

Parameters

team: ID of the team for the player to join.
nobroadcast: When true, the team switch will not be announced in chat.

Return value

Returns true if the player was switched successfully.

Examples

This article lists no examples, please add one.

@@ Line 1: / Line 1: @@
+{{DISPLAYTITLE:Player_SetTeam}}
 {{Template:ACSWarning}}
-'''145:Player_SetTeam (int ''team'', bool ''nobroadcast'')
+'''145:Player_SetTeam (int ''team''[, bool ''nobroadcast''])'''
-==Usage==
+== Usage ==
+Changes the team of the player who activated the special to ''team''. A valid team is anywhere between 0 and sv_maxteams (so 2, 3, 4). The teams are 0 = Blue, 1 = Red, 2 = Green, 3 = Gold. Using the current value of sv_maxteams removes the player from their current team without making them join another.
-Changes the team of the player who activated the special to ''team''. The second argument is optional and only available in Zandronum 3.1, which suppresses the "{player} joined the {team}" message.
+=== Parameters ===
+* ''team'': ID of the team for the player to join.
+* ''nobroadcast'': When true, the team switch will not be announced in chat.
-==Example==
+=== Return value ===
+Returns true if the player was switched successfully.
+== Examples ==
 {{noexamples}}
+[[Category: ACS functions]]
+[[Category: Action specials]]