Helpers propres à Lua

La plupart des fonctions aiLib sont l’équivalent Lua d’une fonction TypeScript et sont documentées à côté d’elle, avec un onglet Lua (voir Toutes les fonctions aiLib). Celles de cette page ont un nom, une forme ou un comportement différent en Lua, elles sont donc documentées ici.

Client : données du joueurCopy Anchor Link

aiLib.playerData.getCopy Anchor Link

La dernière valeur envoyée par ai-core pour une clé des données du joueur local. Si rien n’est arrivé depuis le démarrage de votre ressource, elle demande une fois à ai-core (GetPlayerData) et garde la réponse.

Côté : client · Attend : non

local value = aiLib.playerData.get(key)

TypeScript : les mêmes données via getPlayerData(key) (voir Appartenance et données du joueur).

ParamètresCopy Anchor Link

RetourCopy Anchor Link

La valeur : une table pour character, money ({ cash = 500, bank = 5000 }), jobs, job, gangs et metadata ; une chaîne ou nil pour duty et activeGang. nil tant qu’aucun personnage n’est chargé ou qu’ai-core ne tourne pas.

ExempleCopy 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

Exécute une fonction chaque fois qu’ai-core pousse une nouvelle valeur d’une clé pour le joueur local (un changement de métier, l’argent, la prise de service). Pour money et metadata, ai-core n’envoie que les entrées modifiées ; aiLib les fusionne, si bien que votre gestionnaire reçoit toujours la table entière.

Côté : client · Attend : non

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

TypeScript : onPlayerData(key, handler) (voir Appartenance et données du joueur).

ParamètresCopy Anchor Link

RetourCopy Anchor Link

Rien. Il n’existe aucun moyen de retirer le gestionnaire ; il disparaît avec votre ressource.

ExempleCopy Anchor Link

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

Serveur : joueurs en ligneCopy Anchor Link

aiLib.online lit les joueurs chargés via les exports d’ai-core, un appel d’export par lecture. Il est prévu pour des recherches au moment d’une action (une commande, un callback), pas pour chaque tick. Le online TypeScript garde un miroir local avec plus de lecteurs et des formes de retour différentes (voir Joueurs).

aiLib.online.characterCopy Anchor Link

Le personnage chargé d’un joueur.

Côté : serveur · Attend : non

local character = aiLib.online.character(src)

ParamètresCopy Anchor Link

RetourCopy Anchor Link

Une table CharacterInfo (id, citizenid, firstname, lastname, birthdate, sex, nationality...), ou nil quand le joueur n’a aucun personnage chargé.

ExempleCopy 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

Le « Prénom Nom » du personnage, sinon le nom FiveM du joueur.

Côté : serveur · Attend : non

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

TypeScript : online.name(source, { fallback }) prend une table d’options au lieu d’un booléen.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

string : le nom du personnage, sinon le nom FiveM (ou "" avec fallback = false, ou quand le joueur est parti).

ExempleCopy Anchor Link

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

aiLib.online.jobsCopy Anchor Link

Tous les métiers d’un joueur, en service ou non.

Côté : serveur · Attend : non

local jobs = aiLib.online.jobs(src)

TypeScript : online.jobs(source) ne renvoie que les noms des métiers ; Lua renvoie les tables d’appartenance.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

Une liste de tables JobMembership ({ job = 'police', grade = 2 }). Une liste vide quand le joueur n’en a aucun ou n’a pas de personnage.

ExempleCopy Anchor Link

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

aiLib.online.gangsCopy Anchor Link

Tous les gangs d’un joueur.

Côté : serveur · Attend : non

local gangs = aiLib.online.gangs(src)

TypeScript : online.gangs(source) ne renvoie que les noms des gangs.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

Une liste de tables GangMembership ({ gang = 'ballas', grade = 0 }), ou une liste vide.

ExempleCopy Anchor Link

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

aiLib.online.jobGradeCopy Anchor Link

Le grade d’un joueur dans un métier.

Côté : serveur · Attend : non

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

ParamètresCopy Anchor Link

RetourCopy Anchor Link

integer (0 = le grade le plus bas), ou nil quand le joueur n’a pas ce métier.

ExempleCopy 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

Le grade d’un joueur dans un gang.

Côté : serveur · Attend : non

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

ParamètresCopy Anchor Link

RetourCopy Anchor Link

integer, ou nil quand le joueur n’est pas dans ce gang.

ExempleCopy Anchor Link

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

aiLib.online.dutyJobCopy Anchor Link

Le métier pour lequel un joueur est en service.

Côté : serveur · Attend : non

local job = aiLib.online.dutyJob(src)

ParamètresCopy Anchor Link

RetourCopy Anchor Link

Le nom du métier, ou nil quand il n’est pas en service.

ExempleCopy Anchor Link

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

aiLib.online.sourcesCopy Anchor Link

Les ids serveur de tous les joueurs qui ont un personnage chargé.

Côté : serveur · Attend : non

local players = aiLib.online.sources()

RetourCopy Anchor Link

Une liste d’ids serveur (vide quand personne n’est chargé ou qu’ai-core ne tourne pas).

ExempleCopy 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

Serveur : permissionsCopy Anchor Link

aiLib.isAdminCopy Anchor Link

Indique si un joueur est admin d’ai-core (ACE ai.admin), ou possède l’ACE que vous nommez.

Côté : serveur · Attend : non

local allowed = aiLib.isAdmin(src, ace)

TypeScript : isAdmin(ace?) est à la place une garde pour onClientCallback / onClientEvent (voir Entrées client). En Lua, protégez un callback avec son option ace, ou appelez aiLib.isAdmin vous-même.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

true quand le joueur possède l’ACE, sinon false.

ExempleCopy Anchor Link

RegisterCommand('fixall', function(source)
    if not aiLib.isAdmin(source) then return end
    -- travail réservé aux admins ici
end, false)

Client : la table menuCopy Anchor Link

aiLib.menuCopy Anchor Link

Les boîtes de dialogue se trouvent sur une seule table. Les noms de premier niveau sont les mêmes fonctions, gardés pour des appels courts :

Les formes de requête sont MenuRequest, InputRequest, ItemPickerRequest et SkillDifficulty. Chaque option et chaque écouteur sont documentés avec les équivalents TypeScript sur Interface partagée.

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)