Exports

Documentation Index

Fetch the complete documentation index at: https://v2-docs.n4.gg/llms.txt

Use this file to discover all available pages before exploring further.

​

Server exports overview

​

HandleConnection (manual connection)

• name (required) — Player name from the connection event.
• source (required) — Player server id (source from playerConnecting).
• deferrals (required) — Deferrals table from the connection callback.
• identifier (optional) — Primary identifier for the player (e.g. license2:xxx). If omitted, the queue will attempt to resolve it internally.

local queue = exports.n4_queue

AddEventHandler('playerConnecting', function(name, _, deferrals)
    local source = source
    local identifier = GetPlayerIdentifierByType(source, 'steam')

    deferrals.defer()
    Wait(0)
    deferrals.update('Checking if you are banned...')

    if IsPlayerBanned(identifier) then
        return deferrals.done('You are banned!')
    end

    queue:HandleConnection(name, source, deferrals, identifier) -- identifier optional
end)

​

Discord exports

• GetDiscordUser / GetDiscordUserBySource — Look up cached Discord user data (e.g. username, nickname, avatar, roles) by primary identifier or by source.
• AddDiscordPrioRole / RemoveDiscordPrioRole — Add or remove a Discord role → priority points entry at runtime without editing config.
• AddWhitelistRoleId / RemoveWhitelistRoleId — Add or remove a role ID from the Discord whitelist at runtime.

local queue = exports.n4_queue

-- Add a priority role when your resource starts
queue:AddDiscordPrioRole('123456789', 5000)

-- Check if a connected player has Discord data
local discord = queue:GetDiscordUserBySource(source)
if discord then
    print(discord.username, discord.avatar)
end

​

Bypass identifiers

• AddBypassIdentifier(identifier) — identifier must be a full identifier string (e.g. license2:xxx, discord:yyy). No duplicates added.
• RemoveBypassIdentifier(identifier) — Removes that identifier from the bypass list.

local queue = exports.n4_queue

-- Grant bypass to a specific license (e.g. through an admin command)
queue:AddBypassIdentifier('license2:abc123...')

-- Revoke bypass
queue:RemoveBypassIdentifier('license2:abc123...')

​

Queue state

• IsPlayerInQueue(identifier) — Returns true if a player with that primary identifier is currently in the queue, false otherwise.
• GetPlayerPosition(identifier) — Returns a table with position (1-based) and totalInQueue, or nil if the player is not in the queue.
• GetQueueLength() — Returns the current number of players in the queue.
• GetPlayerPriorityPoints(identifier) — Returns the priority points for that player if they are in the queue, or nil if not.
• GetTopQueuePlayers(count?) — Returns the top count players (default 10) in the queue. Each entry has priorityPoints, username, and avatar.
• GetEstimatedWaitString(position, startupDelay) — Returns a human-readable estimated wait (e.g. "2m 30s") for someone at the given queue position. Uses startupDelay (seconds) when the server is still in startup; otherwise uses recent advance history. Returns nil when an estimate cannot be computed.
• GetConnectingPlayersCount() — Returns how many players are currently in the connecting state (past the queue, not yet fully loaded in).

local queue = exports.n4_queue

-- Check if in queue and get position
local inQueue = queue:IsPlayerInQueue('license2:abc123...')
local pos = queue:GetPlayerPosition('license2:abc123...')
if pos then
    print('Position:', pos.position, 'of', pos.totalInQueue)
end

-- Queue size and priority
local length = queue:GetQueueLength()
local points = queue:GetPlayerPriorityPoints('license2:abc123...')

-- Top players for a leaderboard
local top = queue:GetTopQueuePlayers(5)
for i, p in ipairs(top) do
    print(i, p.username, p.priorityPoints)
end

-- Estimated wait (e.g. for UI)
local waitStr = queue:GetEstimatedWaitString(3, 0)  -- position 3, no startup delay
if waitStr then
    print('Estimated wait:', waitStr)
end

-- Players past queue but still connecting
local connecting = queue:GetConnectingPlayersCount()

​

Grace priority

• SetGracePriority(identifier, durationSeconds) — Grant grace priority for durationSeconds seconds. Pass 0 or a negative number to clear.
• GetGracePriorityExpiry(identifier) — Returns the Unix timestamp when grace expires, or nil if the player has no grace priority.
• RemoveGracePriority(identifier) — Remove grace priority (e.g. as an admin action).

local queue = exports.n4_queue

-- Grant 10 minutes of grace (e.g. after purchase)
queue:SetGracePriority('license2:abc123...', 600)

-- Check if they still have grace
local expiry = queue:GetGracePriorityExpiry('license2:abc123...')
if expiry and os.time() < expiry then
    print('Grace active until ' .. os.date('%c', expiry))
end

-- Revoke grace priority
queue:RemoveGracePriority('license2:abc123...')

​

Locale

• Locale(key, …) — Returns the localized string for key (same keys as the queue UI). Extra arguments are used for formatting (e.g. Locale('card_position', position, queueLength, points)).

local queue = exports.n4_queue
local msg = queue:Locale('card_position', 1, 10, 5000)

​

GetQueueConfig

• GetQueueConfig() — Returns a read-only table with the current queue configuration (e.g. reserved_slots, max_slots, stack_priority, grace_priority_enabled, grace_priority_points, grace_priority_timer, connection_delay, server_startup_delay, modify_hostname, queue_list_display). Useful for other resources that need to respect queue limits or display info.

local queue = exports.n4_queue
local cfg = queue:GetQueueConfig()
print('Reserved slots:', cfg.reserved_slots, 'Max slots:', cfg.max_slots)

​

Client exports