Server-side function
getBanNick
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.
Syntax
string getBanNick ( ban theBan )
OOP Syntax Help! I don't understand this!
- Method: ban:getNick(...)
- Variable: .nick
- Counterpart: setBanNick
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
- addBan
- banPlayer
- getBanAdmin
- getBanIP
- getBanNick
- getBanReason
- getBanSerial
- getBanTime
- getBanUsername
- getBans
- getUnbanTime
- isBan
- kickPlayer
- setBanAdmin
- setBanNick
- setBanReason
- setUnbanTime
- reloadBans
- removeBan