CreateThread de FiveM y Wait(0) explicados: por qué tu script cuesta ms

Escribes un bucle para verificar algo, y el juego deja de responder, o resmon muestra tu recurso con algunos ms mientras te quedas quieto:

while true do
    -- no Wait here: the game never gets control back
    local ped = PlayerPedId()
end

Este artículo explica cómo funcionan los hilos y Wait en Lua de FiveM, lo que realmente cuesta Wait(0), y cómo escribir bucles que permanezcan económicos.

#Cómo funcionan los hilos en FiveM

Lua en FiveM es cooperativo. Tu script no se ejecuta en paralelo con el juego: se ejecuta cuando el tiempo de ejecución lo llama, y debe devolver el control. Dos cosas hacen que sea posible:

• Los controladores de eventos y las devoluciones de llamada se ejecutan una vez, de principio a fin, y luego regresan.
• Los hilos creados con CreateThread son pequeñas corrutinas que el programador reanuda una y otra vez. Un hilo devuelve el control cuando llama a Wait.

CreateThread(function()
    while true do
        Wait(1000)
        print('one second later')
    end
end)

CreateThread y Citizen.CreateThread son la misma función, al igual que Wait y Citizen.Wait. Usa la que prefieras, pero sé consistente en un script.

#Un bucle while sin Wait congela el juego

Si un hilo nunca llama a Wait, el programador nunca recupera el control. En el cliente, el juego deja de dibujar fotogramas hasta que el bucle termina, y en el servidor, todos los demás scripts esperan el tuyo.

CreateThread(function()
    while true do
        -- missing Wait: this blocks the whole client
    end
end)

Lo mismo ocurre con un repeat … until o un for largo que hace trabajo pesado. Cada bucle que puede ejecutarse por un tiempo necesita un Wait dentro de él. Si un script congela el juego al iniciar, busca primero un bucle como este.

#Qué cuesta Wait(0)

Wait(0) significa: pausa hasta el siguiente fotograma (cliente) o el siguiente tick (servidor), y luego continúa. El bucle se ejecuta nuevamente en cada fotograma, así que a 60 fps su cuerpo se paga 60 veces por segundo.

CreateThread(function()
    while true do
        Wait(0)
        local coords = GetEntityCoords(PlayerPedId())
        local dist = #(coords - vector3(215.0, -810.0, 30.7))
        if dist < 3.0 then
            -- draw a marker, show text...
        end
    end
end)

Un bucle como este cuesta poco. Diez de ellos, en treinta recursos, suman varios ms de tiempo del cliente, que es exactamente lo que resmon muestra como alto ms. El costo no es el Wait(0) en sí, es todo lo que repites en cada fotograma.

#Espera solo lo que necesites

La mayoría de los controles no necesitan ejecutarse cada fotograma. Pregúntate para qué es el bucle:

El truco habitual es dos velocidades: un bucle lento que verifica la distancia, y uno rápido solo mientras el jugador está dentro del área.

local zone = vector3(215.0, -810.0, 30.7)

CreateThread(function()
    while true do
        local sleep = 1000
        local dist = #(GetEntityCoords(PlayerPedId()) - zone)

        if dist < 10.0 then
            sleep = 0
            DrawMarker(1, zone.x, zone.y, zone.z - 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0,
                1.5, 1.5, 0.5, 255, 255, 255, 120, false, false, 2, false, nil, nil, false)
        end

        Wait(sleep)
    end
end)

Lejos de la zona, el hilo se despierta una vez por segundo. Cerca de ella, dibuja en cada fotograma. Resmon baja a casi nada para la mayoría de los jugadores.

Consejo: antes de que recurras a un bucle más rápido, pregúntate si un evento o una bolsa de estado puede decirte cuándo cambia el valor. Ningún bucle es más barato que cualquier Wait.

#SetTimeout: ejecuta algo una vez, más tarde

Si solo necesitas hacer algo una vez después de un retraso, no necesitas un hilo con un Wait:

SetTimeout(5000, function()
    print('five seconds later')
end)

SetTimeout(ms, callback) ejecuta la devolución de llamada una vez después del retraso y no bloquea nada. También existe en el servidor. Para una tarea repetida, un hilo con Wait es la herramienta correcta, ya que SetTimeout no se repite por sí solo.

#Esperando dentro de controladores de eventos

Un controlador de eventos también puede llamar a Wait, porque FiveM lo ejecuta en su propia corrutina. Ten cuidado en el servidor: después de un Wait, el source global ya no apunta al jugador que activó el evento. Guárdalo primero (ver eventos del cliente y el servidor):

RegisterNetEvent('my_script:server:buy', function()
    local src = source
    Wait(500)
    print(('player %s bought something'):format(src))
end)

#Deteniendo un hilo

Un hilo termina cuando su función regresa. Para detener un bucle desde afuera, usa un indicador que el bucle verifica:

local running = true

CreateThread(function()
    while running do
        Wait(500)
        -- work
    end
end)

AddEventHandler('onResourceStop', function(resource)
    if resource == GetCurrentResourceName() then
        running = false
    end
end)

Todos los hilos de un recurso se detienen por sí solos cuando el recurso se detiene, así que solo necesitas esto para detener un bucle mientras el recurso continúa ejecutándose.

#Lista de verificación