BanFromGame: Difference between revisions
DrinkyBird (talk | contribs) (Documented BanFromGame) Tag: Source edit |
DrinkyBird (talk | contribs) (Note that it requires sv_allowacsbanfunction) Tag: Source edit |
||
| Line 4: | Line 4: | ||
== Usage == | == Usage == | ||
Bans a player from the server. | Bans a player from the server. This function requires that the [[Server variables#sv_allowacsbanfunction|sv_allowacsbanfunction]] server variable is enabled. | ||
=== Parameters === | === Parameters === | ||
Revision as of 00:08, 29 January 2024
|
This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports. |
|
This article documents an ACS function which is only available in development builds of Zandronum 3.2 and newer. |
int BanFromGame (int player, int duration[, str reason]) (development version 3.2-alpha and above only)
Usage
Bans a player from the server. This function requires that the sv_allowacsbanfunction server variable is enabled.
Parameters
- player: The number of the player to ban.
- team: The duration the player will be banned for, in minutes. Will be clamped in the range 0-60.
- reason: The reason for the ban.
Return value
Returns 1 if the player was banned successfully, 0 otherwise.
Examples
| This article lists no examples, please add one. |