SetBanReason: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (improve description)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
{{Server function}}
{{Server function}}
{{New items|3.0140|1.4|
{{New items|3.0140|1.4|
This function sets new reason for a [[ban]].
This function sets the reason for the specified [[ban]].
}}
}}


Line 9: Line 9:
bool setBanReason( ban theBan, string theReason )
bool setBanReason( ban theBan, string theReason )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[ban]]:setReason|reason|getBanReason}}


===Required Arguments===  
===Required Arguments===  
Line 37: Line 39:
==See Also==
==See Also==
{{Admin_functions}}
{{Admin_functions}}
[[ru:setBanReason]]

Latest revision as of 14:37, 7 August 2016

This function sets the reason for the specified ban.

Syntax

bool setBanReason( ban theBan, string theReason )


OOP Syntax Help! I don't understand this!

Method: ban:setReason(...)
Variable: .reason
Counterpart: getBanReason


Required Arguments

  • theBan: The ban that you wish to set the reason of.
  • theReason: the new reason (max 60 characters).

Returns

Returns true if the new reason was set successfully, false otherwise.

Example

This example adds the command setreason which can be used to change the reason of a ban by nickname of the banned player. For example: setreason someguy reason.

function setReason (player,cmd,name,...)
	local reason = table.concat({...}," ")
	if name and reason then
		local bans = getBans()
		for i,v in ipairs(bans)do
			if getBanNick(v) == name then
				setBanReason(v,reason)
				outputChatBox("Successfully edited the new Ban Reason.",player,0,125,0)
			end
		end
	end
end
addCommandHandler("setreason", setReason)

See Also