GetBanNick

From Multi Theft Auto: Wiki
Revision as of 03:53, 5 June 2010 by Ca11um (talk | contribs) (Added an example.)
Jump to navigation Jump to search

This function will return the nickname (nickname that the player had when he was banned) of the specified ban element.

Syntax

string getBanNick ( ban theBan )

Required Arguments

  • theBan: The ban element which nickname you want to return.

Returns

Returns a string of the nickname if everything was successfull, false if invalid arguments are specified if there was no nickname specified for the ban element.

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