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

Exports · origen_chat

O origen_chat é totalmente compatível com a API de exports standard de chat do FiveM. Todos os exports funcionam tanto através de exports['origen_chat'] como através do sistema de eventos legado __cfx_export_chat_* (por isso, os recursos que já usam exports['chat'] continuam a funcionar sem alterações).


Exports do servidor

addMessage(target, message)

Envia uma mensagem a um jogador (ou a todos se target = -1).

lua
exports['origen_chat']:addMessage(-1, {
    color     = { 255, 0, 0 },
    multiline = true,
    args      = { 'Server', 'Hello everyone!' },
})
 
-- Send to a specific player
exports['origen_chat']:addMessage(source, {
    args = { 'A message just for you' }
})

registerMessageHook(hook)

Regista um hook que interceta todas as mensagens do chat antes de serem enviadas. O hook recebe os dados da mensagem e pode modificá-la ou cancelá-la.

lua
exports['origen_chat']:registerMessageHook(function(source, outgoing, cancel)
    -- outgoing: the message object
    -- cancel(): call to prevent the message from being sent
    if string.find(outgoing.args[1], 'badword') then
        cancel()
    end
end)

registerCommand(commands, handler, properties)

Regista um comando do servidor que aparece no preenchimento automático do chat.

lua
exports['origen_chat']:registerCommand('mycommand', function(source, args, rawCommand)
    print('Command used by', source)
end, {
    help   = 'My custom command',
    params = {
        { name = 'target', help = 'Player ID' }
    }
})

resetChat(target)

Limpa o histórico do chat de um jogador (ou de todos se target = -1).

lua
exports['origen_chat']:resetChat(-1)

Exports do cliente

addMessage(message)

Mostra uma mensagem no chat do jogador local.

lua
exports['origen_chat']:addMessage({
    color     = { 255, 255, 0 },
    multiline = true,
    args      = { 'System', 'You have received a reward!' },
})

addSuggestion(name, help, params)

Adiciona uma sugestão de preenchimento automático de comandos à entrada do chat.

lua
exports['origen_chat']:addSuggestion('/mycommand', 'Does something useful', {
    { name = 'target', help = 'Player ID' }
})

removeSuggestion(name)

Remove uma sugestão de preenchimento automático de comandos.

lua
exports['origen_chat']:removeSuggestion('/mycommand')

clearChat()

Apaga todas as mensagens do chat do jogador local.

lua
exports['origen_chat']:clearChat()