AddBan: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added an example.)
Line 27: Line 27:


==Example==
==Example==
<section name="Serverside example" class="server" show="true">
This example bans a player's IP with the reason "Requested" when they type "/ban-me".
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function banMe ( source, command ) -- The function header and where source is defined
local ipToBan = getPlayerIP ( source ) -- Get the player's IP
addBan ( ipToBan, source, "Requested" ) -- Ban him with the reason; Requested
end
addCommandHandler ( "ban-me", banMe ) -- Make it trigger when a player types "/ban-me"
</syntaxhighlight>
</syntaxhighlight>
 
</section>
==See Also==
==See Also==
{{Admin functions}}
{{Admin functions}}
[[Category:Needs Example]]
[[ru:addBan]]
[[ru:addBan]]

Revision as of 19:49, 23 February 2010

This function will add a ban for the specified IP/username/serial to the server.

Syntax

ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] )         

Note: One of the three: IP, Username or Serial have to be specified.

Required Arguments

  • IP: The IP to be banned. If you don't want to ban by IP, set this to nil.

or

  • Username: The username to be banned. If you don't want to ban by username, set this to nil.

or

  • Serial: The serial to be banned. If you don't want to ban by serial, set this to nil.

or any combination.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • responsibleElement: The element that is responsible for banning the IP/username/serial. This can be a player or the root (getRootElement()).
  • reason: The reason the IP/username/serial 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

Returns true if the IP/username/serial was banned succesfully, false if invalid arguments are specified.

Example

Click to collapse [-]
Serverside example

This example bans a player's IP with the reason "Requested" when they type "/ban-me".

function banMe ( source, command ) -- The function header and where source is defined
	local ipToBan = getPlayerIP ( source ) -- Get the player's IP
	addBan ( ipToBan, source, "Requested" ) -- Ban him with the reason; Requested
end
addCommandHandler ( "ban-me", banMe ) -- Make it trigger when a player types "/ban-me"

See Also