KickFromGame: Difference between revisions

no edit summary
No edit summary
No edit summary
Tag: Source edit
Line 1: Line 1:
{{ACSWarning}}
{{ACSWarning}}
int '''KickFromGame''' (int ''player'', str ''reason'')
bool '''KickFromGame''' (int ''player'', str ''reason'')


*''player'': player to be kicked to spectators
== Usage ==
*''reason'': reason given
Forces the given player to spectate with the given reason. This is equivalent to the <tt>kickfromgame</tt> and <tt>kickfromgame_idx</tt> [[Console Commands|console commands]].


Forces the given player to spectate with the given reason. Returns 1 on success, 0 on failure.
=== Parameters ===
* ''player'': The player to be kicked to spectator.
* ''reason'': The reason that will be displayed.


[[Category: ACS Functions]]
=== Return value ===
Returns true if the player was forced to spectate; false otherwise.
 
== Examples ==
{{noexamples}}
 
[[Category: ACS functions]]