RemoveBan: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool removeBan ( ban theBan, [ player responsibleElement ] )
bool removeBan ( ban theBan [, player responsibleElement = nil ] )
</syntaxhighlight>
</syntaxhighlight>


Line 21: Line 21:
This example removes all the bans when the resource is started and outputs to everyone the players.
This example removes all the bans when the resource is started and outputs to everyone the players.
<syntaxhighlight lang="lua">addEventHandler("onResourceStart",resourceRoot,function()
<syntaxhighlight lang="lua">addEventHandler("onResourceStart",resourceRoot,function()
bans = getBans
bans = getBans()
for i,d in ipairs(bans)do
for i,d in ipairs(bans)do
nick = getBanNick(d)
nick = getBanNick(d)

Revision as of 12:52, 28 November 2012

This function will remove a specific ban.

Syntax

bool removeBan ( ban theBan [, player responsibleElement = nil ] )

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

See Also