AddBan: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Admin rights required.)
 
(15 intermediate revisions by 10 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server function}}
This function will add a ban for the specified IP/username/serial to the server.
This function will add a [[ban]] for the specified IP/username/serial to the server.
{{Note|One of the three: IP, Username or Serial have to be specified.}}
{{note| Don't forget to give admin rights to the resource, in which you are using addBan function or it won't work.}}


==Syntax==  
==Syntax==  
Line 7: Line 9:
ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] )         
ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] )         
</syntaxhighlight>
</syntaxhighlight>
'''Note:''' One of the three: IP, Username or Serial have to be specified.
 
{{OOP||[[Ban]]}}


===Required Arguments===  
===Required Arguments===  
*'''IP:''' The IP to be banned. If you don't want to ban by IP, set this to ''nil''.
*'''IP:''' The IP to be banned. If you don't want to ban by IP, set this to ''nil''.
'''or'''
'''or'''
*'''Username:''' The username to be banned. If you don't want to ban by username, set this to ''nil''.
*'''Username:''' The [http://community.mtasa.com/ MTA Community] username to be banned (now obsolete). If you don't want to ban by username, set this to ''nil''.
'''or'''
'''or'''
*'''Serial:''' The serial to be banned. If you don't want to ban by serial, set this to ''nil''.
*'''Serial:''' The serial to be banned. If you don't want to ban by serial, set this to ''nil''.
Line 24: Line 27:


===Returns===
===Returns===
Returns ''true'' if the IP/username/serial was banned succesfully, ''false'' if invalid arguments are specified.
Returns the new [[ban]] if the IP/username/serial was banned successfully, ''false'' if invalid arguments are specified.


==Example==
==Example==
This example bans a player's IP with the reason "Requested" when they type "/ban-me".
<syntaxhighlight lang="lua">
function banMe ( source, command ) -- The function header and where source is defined
local ipToBan = getPlayerIP ( source ) -- Get the player's IP
addBan ( ipToBan, nil, nil, source, "Requested" ) -- Ban him with the reason; Requested
end
addCommandHandler ( "ban-me", banMe ) -- Make it trigger when a player types "/ban-me"
</syntaxhighlight>
==Example 2==
This example add command to ban player serial.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function banPlayer( thePlayer, theCommand, theTarget, theReason, theSeconds )
function banSerial( source, command, noob, reason )
if theTarget and theReason then
  if ( noob ) then
local target = getPlayerFromName(theTarget)
      local theNoob = getPlayerFromName( noob )
if target == false then --Check if there is someone online with that name
      if ( theNoob ) then
outputChatbox("There isn't someone online with that name.", thePlayer)
        local theNoobSerial = getPlayerSerial( theNoob )
return
        addBan( nil, nil, theNoobSerial, source, reason )
end
      end
if hasObjectPermissionTo( thePlayer, "function.addBan", false) then
  end
--Check if the player has the permission to ban someone
if hasObjectPermissionTo( getThisResource(), "function.addBan", true) then
--Check if this resource has the permission to ban a player
if theSeconds then
--If there is a time specified we use it
addBan(theTarget, thePlayer, theReason, tonumber(theSeconds))
--We ban the target by it's name.
else
--If there wasn't a time specified
addBan(theTarget, thePlayer, theReason)
--Ban him permanent
end
else
--If the resource doesn't have the permission to use addBan
outputChatBox("This resource has not acces to use the addBan function.", thePlayer)
end
else
--If the user doesn't have the permission to use addBan
outputChatBox("You do not have the acces to use the addBan function.", thePlayer)
end
else
--Tell the syntax to the player
outputChatBox("Syntax: /ban targetname reason (seconds)", thePlayer)
end
end
end
addCommandHandler("ban", banPlayer)
addCommandHandler( "ban-serial", banSerial )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Admin functions}}
{{Admin functions}}
[[Category:Needs Example]]
[[ru:addBan]]
[[ru:addBan]]

Latest revision as of 17:08, 6 December 2023

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

[[{{{image}}}|link=|]] Note: One of the three: IP, Username or Serial have to be specified.
[[{{{image}}}|link=|]] Note: Don't forget to give admin rights to the resource, in which you are using addBan function or it won't work.

Syntax

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


OOP Syntax Help! I don't understand this!

Method: Ban(...)


Required Arguments

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

or

  • Username: The MTA Community username to be banned (now obsolete). 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 the new ban if the IP/username/serial was banned successfully, false if invalid arguments are specified.

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, nil, nil, source, "Requested" ) -- Ban him with the reason; Requested
end
addCommandHandler ( "ban-me", banMe ) -- Make it trigger when a player types "/ban-me"

Example 2

This example add command to ban player serial. 

function banSerial( source, command, noob, reason )
   if ( noob ) then
      local theNoob = getPlayerFromName( noob )
      if ( theNoob ) then
         local theNoobSerial = getPlayerSerial( theNoob )
         addBan( nil, nil, theNoobSerial, source, reason )
      end
   end
end
addCommandHandler( "ban-serial", banSerial )

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/AddBan?oldid=78642"