Pair: setUnbanTime

This function will return the unbanning time of the specified ban in seconds.

OOP Syntax Help! I don't understand this!

• Method: ban:getUnbanTime(...)
• Variable: .unbanTime

Syntax

int|false getUnbanTime ( ban theBan )

Required Arguments

• theBan: The ban in which you wish to retrieve the unban time of.

Returns

• int|false: unban time

Returns an integer of the unbanning time in the format of seconds from the year 1970. Use in conjunction with getRealTime in order to retrieve detailed information. Returns false if invalid arguments are specified or if there was no unbanning time specified for the ban.

Code Examples

Example 1 Example 2 (OOP)

server

local function listBans(plr)
    local bansList = getBans() -- Return a table of all the bans.

    for banID, ban in ipairs(banList) do -- For every ban do the following...
        local nick = getBanNick(ban) -- Get the IP of the ban
        local timetounban = getUnbanTime(ban) -- get the time to wait of the banned player

        if (nick) then
            outputChatBox("Ban #" .. banID .. ": " .. nick.." || Time to unban: "..timetounban , plr, 255, 0, 0) -- Output the baninfo
        end
    end
end
addCommandHandler("bans", listBans) -- Add "/bans" as the trigger for the function.

server

OOP Required

local function listBans(plr)
    local bansList = Ban.getList() -- Return a table of all the bans.

    for banID, ban in ipairs(banList) do -- For every ban do the following...
        local nick = ban.nick -- Get the IP of the ban
        local timetounban = ban.unbanTime -- get the time to wait of the banned player

        if (nick) then
            plr:outputChat("Ban #" .. banID .. ": " .. nick.." || Time to unban: "..timetounban , 255, 0, 0) -- Output the baninfo
        end
    end
end
addCommandHandler("bans", listBans) -- Add "/bans" as the trigger for the function.

See Also

Admin Functions

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

Reference

• Scripting Functions