Início › Documentação › Personalização · origen_chat

Personalização · origen_chat

A pasta custom/ permite-te integrar qualquer framework, sistema de notificações ou filtro do chat sem mexer no núcleo. Todos os ficheiros são escrow_ignore, por isso mantêm-se após as atualizações.

text
custom/
├── client/
│   ├── framework.lua   — player job (client-side)
│   ├── notify.lua      — notifications
│   └── chat.lua        — chat open gate, raw message hook
└── server/
    ├── framework.lua   — player identifier, name, job, group
    └── permissions.lua — permission check

custom/client/framework.lua

Custom.GetPlayerJob() → { name, label?, grade: { name, level } }

Devolve o trabalho atual do jogador local. Delega em Config.Framework.

lua
Custom.GetPlayerJob = function()
    -- 'qb-core' / 'qbx_core' → Framework.Functions.GetPlayerData().job
    -- 'esx'                   → Framework.GetPlayerData().job (normalized)
    -- 'standalone'            → { name = 'unknown', grade = { name = 'unknown', level = 0 } }
end

custom/client/notify.lua

Custom.Notify(text, type, length)

Mostra uma notificação ao jogador local. É chamada quando Config.CustomNotify = true.

lua
Custom.Notify = function(text, type, length)
    lib.notify({
        description = text,
        type        = type,     -- 'info' | 'success' | 'error'
        duration    = length,
    })
end

custom/client/chat.lua

Custom.CanOpenChat() → boolean

Controla se o jogador local pode abrir a entrada do chat. Devolve false para a bloquear (p. ex. durante uma cutscene).

lua
Custom.CanOpenChat = function()
    return true
end

Custom.OnSendNoCommandMessage(playerId, message)

É chamada quando um jogador envia uma mensagem que não começa por /. Implementa aqui o teu próprio gestor de mensagens sem comando.

lua
Custom.OnSendNoCommandMessage = function(playerId, message)
    -- Example: route to a default /say command
    -- TriggerServerEvent('origen_chat:server:say', message)
end

custom/server/framework.lua

Função Devolve Descrição
Custom.GetIdentifier(source) string | nil Identificador único do jogador
Custom.GetPlayerName(source) string Nome completo do jogador ou 'Unknown'
Custom.GetPlayerJob(source) { name, label, grade } Trabalho e grau do jogador
Custom.GetGroup(source) string | table Grupo de permissões do jogador

Todas as funções delegam automaticamente consoante Config.Framework (qb-core, qbx_core, esx, standalone).

custom/server/permissions.lua

Custom.hasPermission(source, permissions) → boolean, string

Verifica se um jogador pertence a algum dos grupos de permissões indicados. É usada pelos comandos que têm o campo permissions em Config.Commands.

lua
Custom.hasPermission = function(source, permissions)
    -- permissions: array of group names (e.g. { 'admin', 'god' })
    -- returns: true if the player's group is in the list
end