KickFromGame

From Zandronum Wiki
Revision as of 17:49, 2 July 2022 by DrinkyBird (talk | contribs)
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.