KickFromGame: Difference between revisions
DrinkyBird (talk | contribs) No edit summary |
DrinkyBird (talk | contribs) (Link to BanFromGame) Tag: Source edit |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{ACSWarning}} | {{ACSWarning}} | ||
bool '''KickFromGame''' (int ''player'', str ''reason'') | |||
== Usage == | |||
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]]. | |||
=== Parameters === | |||
* ''player'': The player to be kicked to spectator. | |||
* ''reason'': The reason that will be displayed. | |||
[[Category: ACS | === Return value === | ||
Returns true if the player was forced to spectate; false otherwise. | |||
== Examples == | |||
{{noexamples}} | |||
== See also == | |||
* [[BanFromGame]] | |||
[[Category: ACS functions]] | |||
Latest revision as of 23:06, 28 January 2024
|
This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports. |
bool KickFromGame (int player, str reason)
Usage
Forces the given player to spectate with the given reason. This is equivalent to the kickfromgame and kickfromgame_idx console commands.
Parameters
- player: The player to be kicked to spectator.
- reason: The reason that will be displayed.
Return value
Returns true if the player was forced to spectate; false otherwise.
Examples
| This article lists no examples, please add one. |