Player SetTeam: Difference between revisions

Player SetTeam (view source)

109 bytes added , 3 July 2022

no edit summary

1,584

edits

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:Player_SetTeam}}
 {{Template:ACSWarning}}
-int '''Player_SetTeam''' (int ''team'')
+int '''Player_SetTeam''' (int ''team''[, bool ''nobroadcast''])
-int '''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.
-==Usage==
+=== Parameters ===
+* ''team'': ID of the team for the player to join.
+* ''nobroadcast'': When trye, the team switch will not be announced in chat.
-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 his current team without making him join another.
+=== Return value ===
+Returns true if the player was switched successfully.
-The <tt>nobroadcast</tt> argument is optional, and suppresses the "{player} joined the {team}" chat message.
+== Examples ==
+{{noexamples}}
-==Example==
+[[Category:ACS functions]]
-{{noexamples}}