SetPlayerClass: Difference between revisions

no edit summary
(3.1 is released, so Devfeature templates have been removed)
No edit summary
Tag: Source edit
Line 1: Line 1:
{{Template:ACSWarning}}
{{Template:ACSWarning}}
int '''SetPlayerClass'''(int ''player'', str ''class'', bool ''respawn'')
bool '''SetPlayerClass''' (int ''player'', str ''class'', bool ''respawn'')


==Usage==
== Usage ==
Changes the class a player is currently using. Note that in order for this to work, the player must exist and not a true spectator, and the class must be a valid player class that isn't forbidden to the player (eg. the class is restricted to a team the player isn't on).
Changes the class a player is currently using. Note that in order for this to work, the player must exist and not a true spectator, and the class must be a valid player class that isn't forbidden to the player (eg. the class is restricted to a team the player isn't on).


==Parameters==
=== Parameters ===
*player: The number of the player to change their class.
* ''player'': The number of the player whose class with be changed.
*class: The name of the actor to change the player to. This must be a valid actor that inherits from APlayerPawn, or can be "random" to assign a random class.
* ''class'': The name of the actor to change the player to. This must be a valid actor that inherits from {{Zdoomwiki|Classes:PlayerPawn|PlayerPawn}}, or the string "random" to assign a random class.
*respawn: If true, the player will immediately respawn with the new class, otherwise their class won't change until they respawn normally.
* ''respawn'': If true, the player will immediately respawn with the new class, otherwise their class won't change until they respawn normally.


==Return Value==
=== Return value ===
Returns 1 if the player's class was successfully changed, 0 on failure (eg. the player or class don't exist, or if choosing random classes is forbidden).
Returns true if the player's class was successfully changed, false on failure (eg. the player or class don't exist, or if choosing random classes is forbidden).


[[category:ACS Functions]]
== Examples ==
{{noexamples}}
 
[[Category:ACS functions]]