AR/getBanReason: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server function}} This function will return the ban reason of the specified ban. ==Syntax== <syntaxhighlight lang="lua"> string getBanReason ( ban theBan ) </syntaxhighlight> ===Requir...")
 
Line 35: Line 35:


==See Also==
==See Also==
{{Admin functions}}
{{AR/Admin_functions}}
[[ru:getBanReason]]
[[ru:getBanReason]]

Revision as of 18:25, 1 September 2012

This function will return the ban reason of the specified ban.

Syntax

string getBanReason ( ban theBan )

Required Arguments

  • theBan: The ban in which you want to return the reason of.

Returns

Returns a string of the reason if everything was successful, false if invalid arguments are specified if there was no reason specified for the ban.

Example

function outputBan(ban)
	local banned = getBanNick(ban) -- Get the name of the player who was banned
	local banner = getBanAdmin(ban) -- Get the name of the admin who banned the player
	local reason = getBanReason(ban) -- Get the reason the player was banned
	outputChatBox("-----BAN-----",getRootElement(),255,0,0)
	if (banned) then
		outputChatBox("Player banned: "..banned,getRootElement(),255,0,0) -- Output the player name who was banned
	end
	if (banner) then
		outputChatBox("Banner: "..banner,getRootElement(),255,0,0) -- Output the admin name who performed the ban
	end
	if (reason) then
		outputChatBox("Reason: "..reason,getRootElement(),255,0,0) -- outputt the reason the player was banned
	end
end
addEventHandler("onBan",getRootElement(),outputBan) -- When a player is banned trigger the outputBan function

See Also