Eventos de FiveM: RegisterNetEvent, TriggerServerEvent, TriggerClientEvent

La mayoría de los errores de script entre el juego y el servidor se reducen a eventos: un manejador que nunca se ejecuta, un evento enviado a nadie, o un source que apunta al jugador incorrecto.

Este artículo explica cómo funcionan los eventos de red, cómo registrarlos y activarlos en ambas direcciones, y cómo nombrarlos para que dos scripts nunca choquen.

#Los dos lados

Un recurso de FiveM puede tener código en el cliente (una copia por jugador) y en el servidor (una copia). Se comunican a través de eventos:

Los argumentos se serializan, así que puedes enviar números, cadenas, booleanos y tablas. No puedes enviar funciones. Los identificadores de entidad son locales para cada máquina, así que envía un id de red (NetworkGetNetworkIdFromEntity) en su lugar.

#Registrar un manejador

Un manejador es una función que se ejecuta cuando llega el evento. Para un evento que viene de la red también debe marcarlo como permitido:

RegisterNetEvent('my_script:client:notify', function(message)
    print(message)
end)

Esa es la forma corta: RegisterNetEvent con la función como su segundo argumento registra el evento y adjunta el manejador. La forma larga hace lo mismo en dos pasos:

RegisterNetEvent('my_script:client:notify')
AddEventHandler('my_script:client:notify', function(message)
    print(message)
end)

Si solo usas AddEventHandler, el manejador funciona para llamadas locales de TriggerEvent, pero un TriggerServerEvent o TriggerClientEvent del otro lado se ignora. Esa es la razón más común para un evento que no hace nada.

#Cliente a servidor

-- client
TriggerServerEvent('my_script:server:buy', 'water', 2)

-- server
RegisterNetEvent('my_script:server:buy', function(item, amount)
    local src = source
    print(('player %s wants %s x %s'):format(src, amount, item))
end)

En el servidor, la global source contiene el id del jugador que desencadenó el evento. El cliente no lo envía, así que no puede ser falsificado por un cliente que cambie sus argumentos.

#Servidor a cliente

-- server: to one player
TriggerClientEvent('my_script:client:notify', src, 'Purchase done')

-- server: to everyone
TriggerClientEvent('my_script:client:notify', -1, 'Server restart in 5 minutes')

-- client
RegisterNetEvent('my_script:client:notify', function(message)
    print(message)
end)

El segundo argumento de TriggerClientEvent siempre es el destino. Si lo olvidas, tu primer argumento de datos se lee como el id del jugador y el evento no va a ningún lado.

#Guarda source antes de hacer Wait

source no es un valor que poseas, es una global que el tiempo de ejecución establece para el evento que se está ejecutando. Si tu manejador llama a Wait, o llama a algo que produce rendimiento como MySQL.query.await, otro evento puede ejecutarse mientras tanto y source cambia.

RegisterNetEvent('my_script:server:buy', function(item, amount)
    local src = source            -- copy it first

    Wait(500)                     -- or any await
    print(src)                    -- still the right player
    print(source)                 -- may be someone else now
end)

Haz local src = source la primera línea de cada manejador del servidor y usa src después de eso. Lo mismo se aplica dentro de una devolución de llamada que pasas a otra función.

#Nombrando eventos

Los eventos son globales a todo el servidor: cualquier recurso puede activar cualquier nombre de evento. Si dos scripts registran ambos buy o server:buy, ambos manejadores se ejecutan, y un jugador puede activarlos por nombre.

Prefija cada evento con el recurso y el lado:

'my_script:server:buy'
'my_script:client:updateJob'

No reutilices los nombres de los eventos de otros scripts, y no nombres tu evento algo genérico como giveMoney. Un nombre legible también hace que sea obvio en la consola qué script envió qué.

#Nunca confíes en el cliente

Cualquier cosa que venga a través de TriggerServerEvent puede ser disparada por un tramposo con cualquier argumento, en cualquier momento. Comprueba en el servidor:

• que el jugador tiene permiso para hacerlo (trabajo, distancia, tiempo de reutilización),
• que los montos y nombres de artículos sean válidos,
• que nunca tomes el precio o la recompensa de los argumentos.

RegisterNetEvent('my_script:server:buy', function(item, amount)
    local src = source
    if type(amount) ~= 'number' or amount < 1 or amount > 10 then return end
    -- look the price up on the server, do not read it from the client
end)

La lista completa está en securing server events. Para un resultado que debe volver al llamador, una devolución de llamada es más limpia que dos eventos: ve server callbacks on ESX, QBCore and ox_lib.

#Eventos grandes o frecuentes

Cada evento es un mensaje de red. No actives uno cada fotograma, y no envíes una tabla muy grande a todos los jugadores. Si la consola del servidor imprime sobre desbordamiento de eventos confiables, estás enviando demasiado, demasiado rápido: ve reliable network event overflow.

#Lista de verificación