Pair: setBanReason

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

OOP Syntax Help! I don't understand this!

• Method:ban:getReason(...)
• Variable: .reason

Syntax

​string|false 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.

• string|false: reason

Code Examples

Example 1 Example 2 (OOP)

server

local 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-----",root,255,0,0)
    if (banned) then
        outputChatBox("Player banned: "..banned,root,255,0,0) -- Output the player name who was banned
    end
    if (banner) then
        outputChatBox("Banner: "..banner,root,255,0,0) -- Output the admin name who performed the ban
    end
    if (reason) then
        outputChatBox("Reason: "..reason,root,255,0,0) -- outputt the reason the player was banned
    end
end
addEventHandler("onBan", root, outputBan) -- When a player is banned trigger the outputBan function

server

OOP Required

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

See Also

Admin Functions

• addBan
• banPlayer
• getBanAdmin
• getBanIP
• getBanNick
• getBanReason
• getBans
• getBanSerial
• getBanTime
• getUnbanTime
• isBan
• kickPlayer
• reloadBans
• removeBan
• setBanAdmin
• setBanNick
• setBanReason
• setUnbanTime

Reference

• Scripting Functions