BanFromGame: Difference between revisions
DrinkyBird (talk | contribs) m (Copy-paste error) Tag: Source edit |
(Replaced sv_allowacsbanfunction with sv_maxacsbanduration.) Tag: Source edit |
||
| Line 4: | Line 4: | ||
== Usage == | == Usage == | ||
Bans a player from the server. This function requires that the [[Server variables# | Bans a player from the server. This function requires that the [[Server variables#sv_maxacsbanduration|sv_maxacsbanduration]] server variable be greater than zero. | ||
=== Parameters === | === Parameters === | ||
* ''player'': The number of the player to ban. | * ''player'': The number of the player to ban. | ||
* ''duration'': The duration the player will be banned for, in minutes. Will be clamped in the range | * ''duration'': The duration the player will be banned for, in minutes. Will be clamped in the range of 1 to <code>sv_allowacsbanfunction</code>. | ||
* ''reason'': The reason for the ban. | * ''reason'': The reason for the ban. | ||
Latest revision as of 02:39, 27 May 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_maxacsbanduration server variable be greater than zero.
Parameters
- player: The number of the player to ban.
- duration: The duration the player will be banned for, in minutes. Will be clamped in the range of 1 to
sv_allowacsbanfunction. - 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. |