RemoveBan: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 19: Line 19:


==Example==
==Example==
<syntaxhighlight lang="lua">
This example removes all the bans when the resource is started and outputs to everyone the players.
--TODO
<syntaxhighlight lang="lua">addEventHandler("onResourceStart",resourceRoot,function()
bans = getBans
for i,d in ipairs(bans)do
nick = getBanNick(d)
if(removeBan(d))then
ouputChatBox(nick.."has been removed from ban",root)
end
end
end)
</syntaxhighlight>
</syntaxhighlight>



Revision as of 22:20, 27 April 2012

This function will remove a specific ban.

Syntax

bool removeBan ( ban theBan, [ player responsibleElement ] )

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
			ouputChatBox(nick.."has been removed from ban",root)
		end
	end
end)

See Also