Utilidades solo de Lua

La mayoría de las funciones de aiLib son el equivalente en Lua de una función de TypeScript y se documentan junto a ella, con una pestaña Lua (consulta Todas las funciones de aiLib). Las de esta página tienen un nombre, una forma o un comportamiento distintos en Lua, así que se documentan aquí.

Cliente: datos del jugadorCopy Anchor Link

aiLib.playerData.getCopy Anchor Link

El último valor que envió ai-core para una clave de los datos del jugador local. Cuando no ha llegado nada desde que arrancó tu recurso, pregunta una vez a ai-core (GetPlayerData) y guarda la respuesta.

Lado: Cliente · Espera: no

local value = aiLib.playerData.get(key)

TypeScript: los mismos datos mediante getPlayerData(key) (consulta Pertenencia y datos del jugador).

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

El valor: una tabla para character, money ({ cash = 500, bank = 5000 }), jobs, job, gangs y metadata; un string o nil para duty y activeGang. nil mientras no hay ningún personaje cargado o ai-core no está en marcha.

EjemploCopy Anchor Link

RegisterCommand('cash', function()
    local money = aiLib.playerData.get('money') or {}
    aiLib.notify(('Cash: $%s'):format(aiLib.numbers.groupDigits(money.cash or 0)), 'info')
end, false)

aiLib.playerData.onChangeCopy Anchor Link

Ejecuta una función cada vez que ai-core envía un nuevo valor de una clave para el jugador local (un cambio de trabajo, dinero, entrar de servicio). Para money y metadata, ai-core envía solo las entradas cambiadas; aiLib las fusiona, así que tu handler siempre recibe la tabla completa.

Lado: Cliente · Espera: no

aiLib.playerData.onChange(key, function(value) end)

TypeScript: onPlayerData(key, handler) (consulta Pertenencia y datos del jugador).

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

Nada. No hay forma de quitar el handler; desaparece con tu recurso.

EjemploCopy Anchor Link

aiLib.playerData.onChange('duty', function(job)
    if job == 'police' then
        aiLib.notify('You are now on duty', 'success')
    end
end)

Servidor: jugadores en líneaCopy Anchor Link

aiLib.online lee los jugadores cargados mediante los exports de ai-core, una llamada a un export por lectura. Está pensado para consultas cuando ocurre una acción (un comando, un callback), no para cada tick. El online de TypeScript mantiene un espejo local con más lectores y formas de retorno distintas (consulta Jugadores).

aiLib.online.characterCopy Anchor Link

El personaje cargado de un jugador.

Lado: Servidor · Espera: no

local character = aiLib.online.character(src)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

Una tabla CharacterInfo (id, citizenid, firstname, lastname, birthdate, sex, nationality...), o nil cuando el jugador no tiene ningún personaje cargado.

EjemploCopy Anchor Link

aiLib.addCommand('whoami', { help = 'Shows your character id' }, function(source)
    local character = aiLib.online.character(source)
    if not character then return end
    aiLib.notify(source, ('Character #%d (%s)'):format(character.id, character.citizenid), 'info')
end)

aiLib.online.nameCopy Anchor Link

El "Nombre Apellido" del personaje, o si no el nombre de FiveM del jugador.

Lado: Servidor · Espera: no

local name = aiLib.online.name(src, fallback)

TypeScript: online.name(source, { fallback }) acepta una tabla de opciones en lugar de un booleano.

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

string: el nombre del personaje, o si no el nombre de FiveM (o "" con fallback = false, o cuando el jugador ya no está).

EjemploCopy Anchor Link

print(('%s opened the shop'):format(aiLib.online.name(source)))

aiLib.online.jobsCopy Anchor Link

Todos los trabajos de un jugador, esté de servicio o no.

Lado: Servidor · Espera: no

local jobs = aiLib.online.jobs(src)

TypeScript: online.jobs(source) devuelve solo los nombres de los trabajos; Lua devuelve las tablas de pertenencia.

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

Una lista de tablas JobMembership ({ job = 'police', grade = 2 }). Una lista vacía cuando el jugador no tiene ninguno o no tiene personaje.

EjemploCopy Anchor Link

for _, membership in ipairs(aiLib.online.jobs(source)) do
    print(membership.job, membership.grade)
end

aiLib.online.gangsCopy Anchor Link

Todas las bandas de un jugador.

Lado: Servidor · Espera: no

local gangs = aiLib.online.gangs(src)

TypeScript: online.gangs(source) devuelve solo los nombres de las bandas.

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

Una lista de tablas GangMembership ({ gang = 'ballas', grade = 0 }), o una lista vacía.

EjemploCopy Anchor Link

local inAGang = #aiLib.online.gangs(source) > 0

aiLib.online.jobGradeCopy Anchor Link

El rango de un jugador en un trabajo.

Lado: Servidor · Espera: no

local grade = aiLib.online.jobGrade(src, job)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

integer (0 = el rango más bajo), o nil cuando el jugador no está en ese trabajo.

EjemploCopy Anchor Link

local grade = aiLib.online.jobGrade(source, 'police')
if not grade or grade < 2 then return aiLib.fail('NOT_ALLOWED') end

aiLib.online.gangGradeCopy Anchor Link

El rango de un jugador en una banda.

Lado: Servidor · Espera: no

local grade = aiLib.online.gangGrade(src, gang)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

integer, o nil cuando el jugador no está en esa banda.

EjemploCopy Anchor Link

local isBoss = (aiLib.online.gangGrade(source, 'ballas') or -1) >= 3

aiLib.online.dutyJobCopy Anchor Link

El trabajo para el que un jugador está de servicio.

Lado: Servidor · Espera: no

local job = aiLib.online.dutyJob(src)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

El nombre del trabajo, o nil cuando está fuera de servicio.

EjemploCopy Anchor Link

if aiLib.online.dutyJob(source) ~= 'police' then return aiLib.fail('NOT_ON_DUTY') end

aiLib.online.sourcesCopy Anchor Link

Los ids de servidor de todos los jugadores con un personaje cargado.

Lado: Servidor · Espera: no

local players = aiLib.online.sources()

DevuelveCopy Anchor Link

Una lista de ids de servidor (vacía cuando no hay nadie cargado o ai-core no está en marcha).

EjemploCopy Anchor Link

for _, src in ipairs(aiLib.online.sources()) do
    if aiLib.online.dutyJob(src) == 'police' then
        aiLib.notify(src, 'Robbery in progress', 'warning')
    end
end

Servidor: permisosCopy Anchor Link

aiLib.isAdminCopy Anchor Link

Si un jugador es admin de ai-core (ACE ai.admin), o tiene el ACE que indiques.

Lado: Servidor · Espera: no

local allowed = aiLib.isAdmin(src, ace)

TypeScript: isAdmin(ace?) es en su lugar una guarda para onClientCallback / onClientEvent (consulta Entrada del cliente). En Lua, protege un callback con su opción ace, o llama tú mismo a aiLib.isAdmin.

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

true cuando el jugador tiene el ACE, si no false.

EjemploCopy Anchor Link

RegisterCommand('fixall', function(source)
    if not aiLib.isAdmin(source) then return end
    -- trabajo solo para admins aquí
end, false)

Cliente: la tabla menuCopy Anchor Link

aiLib.menuCopy Anchor Link

Los diálogos viven en una sola tabla. Los nombres de nivel superior son las mismas funciones, mantenidas para llamadas cortas:

Las formas de las peticiones son MenuRequest, InputRequest, ItemPickerRequest y SkillDifficulty. Cada opción y listener se documenta con los equivalentes de TypeScript en Interfaz compartida.

RegisterCommand('fine', function()
    local values = aiLib.input({
        title = 'Write a fine',
        confirm = 'Send',
        fields = {
            { name = 'amount', label = 'Amount', type = 'number', min = 1, max = 10000 },
            { name = 'reason', label = 'Reason', type = 'text', maxLength = 80 },
        },
    })
    if values then aiLib.callAction('mypolice:fine', { values.amount, values.reason }, { fallback = 'FINE_FAILED' }) end
end, false)