This function will return a table containing all the bans present in the server's banlist.xml.

OOP Syntax Help! I don't understand this!

• Method: Ban.getList(...)

Syntax

table getBans ( )

Returns

• table: bans

Returns a table containing all the bans.

Code Examples

Example 1 Example 2 (OOP)

server

This example lists every ban when somebody types /bans. WARNING: This will spam chat (for the player that executed the command) if the server has a lot of bans.

local function listBans(playerSource)
    local banList = 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
        if (nick) then
            outputChatBox("Ban #" ..banID..": "..nick, playerSource , 255, 0, 0, true) -- Output the ban.
        end
    end
end
addCommandHandler("bans", listBans) -- Add "/bans" as the trigger for the function.

server

OOP Required

This example lists every ban when somebody types /bans. WARNING: This will spam chat (for the player that executed the command) if the server has a lot of bans.

local function listBans(playerSource)
    local banList = 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
        if (nick) then
            playerSource:outputChat("Ban #" ..banID..": "..nick , 255, 0, 0, true) -- Output the ban.
        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