RU/BanPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Server function}} {{New feature|3|1.0| This function will ban the specified player by either IP, serial or username }} {{Deprecated_feature|3|1.0| This function will ban ...)
 
(Redirected page to RU/banPlayer)
 
Line 1: Line 1:
__NOTOC__
#REDIRECT [[RU/banPlayer]]
{{Server function}}
{{New feature|3|1.0|
This function will ban the specified player by either IP, [[serial]] or username
}}
 
{{Deprecated_feature|3|1.0|
This function will ban the specified player from the server by IP.
}}
 
==Syntax==
{{New feature|3|1.0|
<syntaxhighlight lang="lua">
ban banPlayer ( player bannedPlayer, [ bool IP = true, bool Username = false, bool Serial = false, player responsiblePlayer = nil, string reason = nil, int seconds = 0 ] )
</syntaxhighlight>
}}
 
{{Deprecated_feature|3|1.0|
<syntaxhighlight lang="lua">
bool banPlayer ( player bannedPlayer , [ element responsibleElement, string reason ] )       
</syntaxhighlight>
}}
 
===Required Arguments===
*'''bannedPlayer:''' The player that will be banned from the server.
 
===Optional Arguments===
{{OptionalArg}}
{{New feature|3|1.0|
*'''IP:''' Will player be banned by IP?
*'''Username:''' Will player be banned by username?
*'''Serial:''' Will player be banned by serial?
 
:'''Note:''' to ban by username or serial, ''verifyserials'' must be enabled in the server configuration file.
 
}}
*'''responsibleElement:''' The element that is responsible for banning the player. This can be a player or the root ([[getRootElement]]()).
*'''reason:''' The reason the player will be banned from the server.
*'''seconds:''' The amount of seconds the player will be banned from the server for. This can be 0 for an infinite amount of time.
 
===Returns===
{{Deprecated_feature|3|1.0|
Returns ''true'' if the player was banned succesfully, ''false'' if invalid arguments are specified.
}}
 
{{New feature|3|1.0|
Returns a [[ban]] pointer if banned successfully, or ''false'' if unsuccessful.
}}
 
==Example==
This example lets a player ban anyone if he has ACL rights.
<syntaxhighlight lang="lua">
--Add the "ban" command handler
-- Example with the player
function banPlayerCommand ( theClient, commandName, bannedName, reason )
 
-- Give the player a nice error if he doesn't have rights
if ( hasObjectPermissionTo ( theClient, "function.banPlayer" ) ) then
--Get player element from the name
local bannedPlayer = getPlayerFromNick ( bannedName )
 
--Ban the player
banPlayer ( bannedPlayer, theClient, reason )
outputChatBox ( "ban: " .. bannedName .. " successfully banned", theClient )
 
else
outputChatBox ( "ban: You don't have enough permissions", theClient )
end
 
end
addCommandHandler ( "ban", banPlayerCommand )
 
-- Example function with the root element. Here you would pass a player element to the function.
function banCheater(theCheater)
banPlayer(theCheater, getRootElement(), "You are banned because of cheating.")
end
</syntaxhighlight>
 
==See Also==
{{RU/Admin_functions}}

Latest revision as of 11:38, 22 November 2011

Redirect to:

Retrieved from "https://wiki.multitheftauto.com/wiki/RU/BanPlayer?oldid=28402"