SetBanReason: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
Line 4: | Line 4: | ||
This function sets new reason for a [[ban]]. | This function sets new reason for a [[ban]]. | ||
}} | }} | ||
==Syntax== | ==Syntax== |
Revision as of 22:02, 30 July 2014
This function sets new reason for a ban.
Syntax
bool setBanReason( ban theBan, string theReason )
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
- addBan
- banPlayer
- getBanAdmin
- getBanIP
- getBanNick
- getBanReason
- getBanSerial
- getBanTime
- getBanUsername
- getBans
- getUnbanTime
- isBan
- kickPlayer
- setBanAdmin
- setBanNick
- setBanReason
- setUnbanTime
- reloadBans
- removeBan