Exports

📤 Exports

Server-Side Exports

lb-clubby does not provide direct exports. Instead, it uses lib.callback for server-side communication.

Available Callbacks

Get Clubby Account

local account = lib.callback.await('GET_CLUBBY_ACCOUNT', source)

Returns:

{
    LoggedIn = boolean,
    Username = string,
    PhoneNumber = string,
    Avatar = string,
    Bio = string,
    Banner = string,
    HostedRoomsCount = number
}

Get Clubby Rooms

local rooms = lib.callback.await('GET_CLUBBY_ROOMS', source)

Returns: Array of room objects with room information.

Get Player Profile

local profile = lib.callback.await('GET_PLAYER_PROFILE', source, targetSource)

Parameters:

• source - Server ID of requesting player

• targetSource - Server ID of target player

Returns: Account data for the target player.

Get Player Identifiers

local identifiers = lib.callback.await('GET_PLAYER_IDENTIFIERS', source, targetSource)

Parameters:

• source - Server ID of requesting player

• targetSource - Server ID of target player

Returns: Table of player identifiers (excludes IP address).

Get Clubby Badges

local badges = lib.callback.await('GET_CLUBBY_BADGES', source)

Returns: Badge configuration for hosted rooms.

Framework Integration

The resource uses the following framework exports (automatically handled):

• ESX: exports["es_extended"]:getSharedObject()

• QB-Core: exports['qb-core']:GetPlayer(source)

• QBox: exports.qbx_core:GetPlayer(source)

• Standalone: exports["lb-phone"]:GetEquippedPhoneNumber(source)

Server Events

You can trigger server events from other resources:

Create Room

TriggerServerEvent("CLUBBY_CREATE_ROOM", data)

Data Structure:

{
    name = string,           -- Room name
    description = string,    -- Room description (optional)
    image = string,         -- Room image URL (optional)
    private = boolean,      -- Is private room
    code = string          -- 4-digit code (required if private)
}

Join Room

TriggerServerEvent("CLUBBY_JOIN_ROOM", data)

Data Structure:

{
    roomID = number,        -- Room ID to join
    code = string          -- Room code (required if private)
}

Leave Room

TriggerServerEvent("CLUBBY_LEAVE_ROOM")

Create Account

TriggerServerEvent("CLUBBY_CREATE_ACCOUNT", data)

Data Structure:

{
    Username = string,      -- Username (3-20 characters)
    Avatar = string,        -- Avatar image URL (required)
    Bio = string,          -- Bio text (optional, max 500 chars)
    Banner = string        -- Banner image URL (optional, max 500 chars)
}

Update Account Settings

TriggerServerEvent("CLUBBY_SAVE_SETTINGS", data)

Data Structure:

{
    Avatar = string,        -- Avatar image URL
    Bio = string,          -- Bio text
    Banner = string        -- Banner image URL
}

Client Events

You can listen to these events from other resources:

Room Created/Updated

RegisterNetEvent("CLUBBY_NEWROOM_CREATED")
AddEventHandler("CLUBBY_NEWROOM_CREATED", function(rooms)
    -- rooms: Array of all available rooms
end)

Account Created

RegisterNetEvent("CLUBBY_ACCOUNT_CREATED")
AddEventHandler("CLUBBY_ACCOUNT_CREATED", function(account)
    -- account: Account data object
end)

Account Refreshed

RegisterNetEvent("CLUBBY_ACCOUNT_REFRESH")
AddEventHandler("CLUBBY_ACCOUNT_REFRESH", function(account)
    -- account: Updated account data
end)

Room Joined

RegisterNetEvent("CLUBBY_JOIN_ROOM")
AddEventHandler("CLUBBY_JOIN_ROOM", function(roomData)
    -- roomData: Complete room data with members
end)

Room Left

RegisterNetEvent("CLUBBY_LEAVE_ROOM")
AddEventHandler("CLUBBY_LEAVE_ROOM", function(data)
    -- data: Empty room data
end)

---

📝 Notes

• Rooms are temporary and stored in memory only

• Room history is tracked in the database for badge calculations

• The resource automatically cleans up empty rooms after 5 minutes

• Voice chat requires pma-voice to be properly configured

• Phone numbers are retrieved from your framework or lb-phone