🔌 API Reference

Server Events

daphne_chat:sendMessage

Triggered by client when a message is sent.

Parameters:

content: string        -- The message content
commandUsed: string   -- Command used (optional)

Example:

TriggerServerEvent('daphne_chat:sendMessage', "Hello world!", nil)
TriggerServerEvent('daphne_chat:sendMessage', "This is admin chat", "admin")

daphne_chat:receiveMessage

Triggered by server to client when a message is received.

Parameters:

message: table  -- Message object

Message Structure:

{
    id = "unique_message_id",
    author = {
        id = "player_id",
        username = "PlayerName",
        avatar = "avatar_url",
        color = "#ffffff",
        roles = { {name: "Admin", color: "#ef4444", priority: 100} }
    },
    content = "Message text",
    timestamp = 1234567890000,  -- Milliseconds
    type = "chat_mode_id",
    mode = { ... }  -- ChatMode object
}

daphne_chat:saveConfig

Triggered by admin editor to save configuration.

Parameters:

config: table  -- Complete ChatConfig object

Example:

TriggerServerEvent('daphne_chat:saveConfig', newConfig)

daphne_chat:reloadConfig

Triggered to reload configuration from file.

Usage:

TriggerEvent('daphne_chat:reloadConfig')

daphne_chat:requestConfig

Triggered by client on resource start to get initial config.

Example:

TriggerServerEvent('daphne_chat:requestConfig')

daphne_chat:configUpdated

Triggered by server to all clients when config is updated.

Parameters:

newConfig: table  -- Updated ChatConfig object

Example:

RegisterNetEvent('daphne_chat:configUpdated', function(newConfig)
    print("Config updated!")
    -- Handle config update
end)

daphne_chat:openConfigEditor

Triggered by server to open admin editor for specific player.

Parameters:

config: table  -- Current ChatConfig object

Example:

TriggerClientEvent('daphne_chat:openConfigEditor', source, chatConfig)

daphne_chat:systemMessage

Triggered by server to send system message.

Parameters:

text: string  -- System message text

Example:

TriggerClientEvent('daphne_chat:systemMessage', -1, "^2Server will restart in 5 minutes")

daphne_chat:cooldownActive

Triggered by server to client when a command is on cooldown.

Parameters:

{
    modeId: string,
    remaining: number,    -- Remaining seconds
    commandName: string
}

Client Events

daphne_chat:receiveMessage

Listen for incoming messages from server.

Parameters:

message: table  -- Message object

Example:

RegisterNetEvent('daphne_chat:receiveMessage', function(message)
    print("Received message:", message.content)
end)

daphne_chat:systemMessage

Listen for system messages.

Parameters:

text: string  -- System message text

Example:

RegisterNetEvent('daphne_chat:systemMessage', function(text)
    print("System message:", text)
end)

daphne_chat:configUpdated

Listen for config updates.

Parameters:

newConfig: table  -- Updated ChatConfig object

Example:

RegisterNetEvent('daphne_chat:configUpdated', function(newConfig)
    print("Config updated!")
    -- Update local config cache
end)

daphne_chat:openConfigEditor

Listen for admin editor open request.

Parameters:

config: table  -- Current ChatConfig object

Example:

RegisterNetEvent('daphne_chat:openConfigEditor', function(config)
    print("Opening config editor")
    -- Open admin editor UI
end)

daphne_chat:configSaveResult

Listen for config save result.

Parameters:

{
    success: boolean,
    error?: string
}

Example:

RegisterNetEvent('daphne_chat:configSaveResult', function(result)
    if result.success then
        print("Config saved successfully")
    else
        print("Failed to save config:", result.error)
    end
end)

daphne_chat:cooldownActive

Listen for cooldown activation.

Parameters:

{
    modeId: string,
    remaining: number,
    commandName: string
}

Example:

RegisterNetEvent('daphne_chat:cooldownActive', function(data)
    print(string.format("Command %s on cooldown: %d seconds remaining", 
        data.commandName, data.remaining))
end)

daphne_chat:cooldownUpdate

Listen for cooldown updates (countdown).

Parameters:

{
    modeId: string,
    remaining: number,
    commandName: string
}

daphne_chat:cooldownExpired

Listen for cooldown expiration.

Parameters:

{
    modeId: string
}

NUI Callbacks

sendMessage

From React UI to client.

Parameters:

{
    message: string
}

Response:

{ ok: true }

Example:

fetchNui<boolean>('sendMessage', { message: 'Hello!' })

closeChat

From React UI to client.

Parameters: None

Response:

{ ok: true }

saveConfig

From React UI (Admin Editor) to server.

Parameters:

{
    config: ChatConfig
}

Response:

{ ok: true }

closeConfigEditor

From React UI (Admin Editor) to client.

Parameters: None

Response:

{ ok: true }

React Messages (Client → React)

setInputActive

Set chat input visibility.

Parameters:

{
    active: boolean
}

Example:

SendReactMessage('setInputActive', { active = true })

addMessage

Add message to chat.

Parameters:

{
    message: Message
}

Example:

SendReactMessage('addMessage', { message = messageData })

setConfig

Set initial config.

Parameters:

{
    config: ChatConfig
}

Example:

SendReactMessage('setConfig', { config = chatConfig })

configUpdated

Notify React of config update.

Parameters:

{
    config: ChatConfig
}

openConfigEditor

Open admin editor.

Parameters:

{
    config: ChatConfig
}

cooldownActive

Notify React of cooldown.

Parameters:

{
    modeId: string,
    remaining: number,
    commandName: string
}

cooldownUpdate

Update cooldown countdown.

Parameters:

{
    modeId: string,
    remaining: number,
    commandName: string
}

cooldownExpired

Notify React of cooldown expiration.

Parameters:

{
    modeId: string
}