Referência da APILib para Lua
Todas as funções do aiLib
A lista completa dos membros do aiLib: lado, se a chamada espera, e a página que a documenta com a aba Lua.
Todo membro do aiLib, a partir do init.lua do ai-lib. A maioria é o equivalente de uma função TypeScript e está documentada na página dessa função, com a chamada Lua no bloco de assinatura e uma aba de exemplo em Lua. Espera significa que a chamada pausa até a resposta chegar: chame dentro de uma thread (veja Funções que esperam).
Os métodos de uma classe (points:add(...), job:set(...)) são listados junto com a classe.
Os dois lados
| Função | Espera | Documentado em |
|---|---|---|
aiLib.side | não | Lib para Lua |
aiLib.every(ms, fn, options?), job:set(active), job:stop(), job.running | não | Agendamento: every |
aiLib.waitFor(check, timeout?, interval?) | sim | Agendamento: waitFor |
aiLib.formatText(text, ...) | não | Textos e números: formatText |
aiLib.locale(resource?) | não | Idioma: createLocale |
aiLib.fail(error) | não | Ações e entrada do cliente: fail |
aiLib.numbers.round(value, decimals?) | não | Textos e números: round |
aiLib.numbers.groupDigits(value, separator?) | não | Textos e números: groupDigits |
aiLib.numbers.headingTo(from, to) | não | Posições: headingTo |
aiLib.stripGameText(text) | não | Textos e números: stripGameText |
aiLib.notify(...): cliente (text, kind?, duration?), servidor (source, text, kind?, duration?) | não | Cliente: UI compartilhada, Servidor: Jogadores |
aiLib.inventory, aiLib.world, aiLib.appearance, aiLib.mdt | veja abaixo | Os membros mudam conforme o lado (abaixo). |
Cliente
| Função | Espera | Documentado em |
|---|---|---|
aiLib.triggerServerCallback(name, args?, timeout?) | sim | Falando com o servidor |
aiLib.onServerCallback(name, handler) | não | Falando com o servidor |
aiLib.onServerEvent(name, handler) | não | Falando com o servidor |
aiLib.callAction(name, args?, { fallback, timeout?, silent? }) | sim | Falando com o servidor |
aiLib.cache (ped, playerId, serverId, vehicle, seat, weapon), aiLib.cache.onChange(key, handler) | não | O jogador local |
aiLib.player (coords, heading, distanceTo, freeze, teleport, playAnim, stopAnim) | teleport sim | O jogador local |
aiLib.fadeOut(ms?), aiLib.fadeIn(ms?) | sim | O jogador local |
aiLib.playerPed(serverId) | não | O jogador local |
aiLib.nearestPlayer(metres, { from?, filter? }) | não | O jogador local |
aiLib.playerData.get(key), aiLib.playerData.onChange(key, handler) | não | Helpers só de Lua |
aiLib.Points.new(): :add, :addModel, :addVehicle, :remove, :clear, :refresh | não | Pontos de interação |
aiLib.Zones.new(): :add, :remove, :clear, :isInside | não | Zonas |
aiLib.LocalPed.new(options): :remove | não | Peds, blips e props |
aiLib.Blips.new(): :add, :get, :remove, :clear; aiLib.Blips.create(options) | não | Peds, blips e props |
aiLib.progress(options), aiLib.progress.cancel(), aiLib.progress.isRunning() | progress sim | UI compartilhada |
aiLib.menu.show(request, listeners?) | sim | UI compartilhada, a tabela menu |
aiLib.input(request) / aiLib.menu.input | sim | UI compartilhada |
aiLib.itemPicker(request) / aiLib.menu.itemPicker | sim | UI compartilhada |
aiLib.skillCheck(difficulty, keys?) / aiLib.menu.skillCheck | sim | UI compartilhada |
aiLib.lockpick(options?) / aiLib.menu.lockpick | sim | UI compartilhada |
aiLib.showPrompt(id, text), aiLib.hidePrompt(id), aiLib.onPromptPressed(handler) | não | UI compartilhada |
aiLib.hud (hide, show, visible) | não | Telas e controles |
aiLib.keyHints (show, hide) | não | Telas e controles |
aiLib.controls (disable, disableAll, enable) | não | Telas e controles |
aiLib.Keybind.new(options): :disable | não | Teclas de atalho |
aiLib.inventory (openInventory, hasItem, currentWeapon) | não | Camadas pelo ai-core |
aiLib.world (pauseSync, resumeSync) | não | Camadas pelo ai-core |
aiLib.appearance (apply, read, openMenu, wearOutfit, reloadSkin) | não | Camadas pelo ai-core |
aiLib.gestures (isHandsUp, isPointing, provider, playEmote, cancelEmote, emoteProvider) | não | Camadas pelo ai-core |
aiLib.seatbelt (isOn, onChange, provider) | não | Camadas pelo ai-core |
aiLib.radial (add, remove, refresh) | não | Camadas pelo ai-core |
aiLib.mdt.open() | não | Camadas pelo ai-core |
aiLib.nearestVehicle(metres, { networked?, notOwn?, filter? }) | não | Veículos e entidades |
aiLib.waitForEntity(netId, timeout?) | sim | Veículos e entidades |
aiLib.raycast(from, to, options?) | não | Sondagens e carregamento |
aiLib.groundZ(x, y, z?), aiLib.locationName(coords?), aiLib.vehicleLabel(vehicle), aiLib.waypoint() | não | Sondagens e carregamento |
aiLib.pedHeadshot(ped, transparent?, timeout?) | sim | Sondagens e carregamento |
aiLib.onShot(handler) | não | Sondagens e carregamento |
aiLib.requestModel, requestAnimDict, requestAnimSet, requestPtfxAsset, requestTextureDict, requestWeaponAsset (name, timeout?) | sim | Sondagens e carregamento |
aiLib.ModelPoints e aiLib.targets são internos (servem Points:addModel e os adaptadores de scripts de target); não os chame.
Servidor
| Função | Espera | Documentado em |
|---|---|---|
aiLib.onClientCallback(name, handler, { rate?, lock?, ace? }) | não | Entrada do cliente |
aiLib.onClientEvent(name, handler, { rate?, ace? }) | não | Entrada do cliente |
aiLib.triggerClientCallback(name, source, args?, timeout?) | sim | Entrada do cliente |
aiLib.progressFor(source, options) | sim | Entrada do cliente |
aiLib.minigameFor(source, options) | sim | Entrada do cliente |
aiLib.isAdmin(source, ace?) | não | Helpers só de Lua |
aiLib.addCommand(name, options, handler) | não | Comandos |
aiLib.online (character, name, jobs, gangs, jobGrade, gangGrade, dutyJob, sources) | não | Helpers só de Lua |
aiLib.onCharacter({ loaded?, unloaded? }) | não | Jogadores e personagens |
aiLib.playersNear(source, radius), aiLib.playersNearEntity(entity, radius), aiLib.nearestPlayerTo(source, metres, filter?) | não | Jogadores e personagens |
aiLib.RateLimit.new(count, windowMs): :take(source), :release(source) | não | Jogadores e personagens |
aiLib.inventory (addItem, removeItem, getItemCount, hasItem, canCarryItem, getItems, clearInventory, registerStash, openInventory, registerUsableItem, getItemDefinition, registerShop, openShop) | não | Itens |
aiLib.spawnVehicle(options) | sim | Veículos |
aiLib.vehicleKeys (give, remove, has) | não | Veículos |
aiLib.vehicleFromNet(netId), aiLib.vehicleNearPlayer(source, netId, options?), aiLib.nearestVehicleTo(source, metres, filter?) | não | Veículos |
aiLib.billing (send, unpaid, pay, provider) | unpaid sim | Dinheiro e banco |
aiLib.banking (open, societyBalance, provider) | não | Dinheiro e banco |
aiLib.dispatch.alert(alert) | não | Empregos e serviços |
aiLib.prison (jail, release, timeLeft) | não | Empregos e serviços |
aiLib.mdt (record, provider) | não | Empregos e serviços |
aiLib.ems (available, distress, provider) | não | Empregos e serviços |
aiLib.stress (gain, relieve, provider) | não | Empregos e serviços |
aiLib.world (getWeather, setWeather, getTime, setTime, setBlackout, freezeTime) | não | Mundo |
aiLib.phone (number, sourceOf, hasPhone, mail, message, notify) | não | Celular e aparência |
aiLib.appearance (get, provider) | get sim | Celular e aparência |
aiLib.aiLog(channel, message, options?) | não | Logs |