RemoveBan: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Added oop syntax) |
||
| Line 7: | Line 7: | ||
bool removeBan ( ban theBan [, player responsibleElement = nil ] ) | bool removeBan ( ban theBan [, player responsibleElement = nil ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Ban]].remove||}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
Revision as of 15:18, 6 August 2016
This function will remove a specific ban.
Syntax
bool removeBan ( ban theBan [, player responsibleElement = nil ] )
OOP Syntax Help! I don't understand this!
- Method: Ban.remove(...)
Required Arguments
- theBan: The ban to be removed.
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 removing the ban element. This can be a player or the root (getRootElement()).
Returns
Returns true if the ban was removed succesfully, false if invalid arguments are specified.
Example
This example removes all the bans when the resource is started and outputs to everyone the players.
addEventHandler("onResourceStart",resourceRoot,function()
bans = getBans()
for i,d in ipairs(bans)do
nick = getBanNick(d)
if(removeBan(d))then
outputChatBox(nick.."has been removed from ban",root)
end
end
end)
This example removes the ban for IP 1.2.3.4
for _,ban in ipairs(getBans())do
if getBanIP(ban) == "1.2.3.4" then
removeBan(ban)
end
end