AI Core
Referência da APILib: cliente

Lib: cliente

@aicore8/lib/client e o lado cliente do aiLib: o que são, como carregá-los em TypeScript e Lua, e todas as páginas de tópicos.

A lib do cliente é o conjunto de helpers que todo script de cliente ai-* usa em vez de escrever natives à mão: falar com o servidor, o jogador local, pontos de interação, zonas, peds e blips, a UI compartilhada (notificações, barra de progresso, menus, minigames), teclas de atalho, e as camadas que alcançam qualquer script de HUD, morte, roupas ou emotes que o servidor roda, pelo ai-core.

TypeScript

Importe de @aicore8/lib/client em arquivos dentro de resource/client/. Helpers que funcionam em qualquer lado (recusas, leitores de entrada, matemática, RecordObjects, ServerClock) vêm de @aicore8/lib/shared.

resource/client/index.ts
import { Points, notify, progress, cache } from "@aicore8/lib/client";
import { RecordObjects, ServerClock } from "@aicore8/lib/shared";

Todo recurso feito a partir do template do ai-core já depende do pacote ("@aicore8/lib": "workspace:*" no package.json); o build o empacota em dist/client.js.

Lua

Recursos em Lua recebem os mesmos helpers na tabela global aiLib, do recurso ai-lib. Adicione duas linhas ao seu fxmanifest.lua:

fxmanifest.lua
dependency 'ai-lib'
shared_script '@ai-lib/init.lua'

Depois chame aiLib.<name> em qualquer arquivo de cliente. Cada módulo carrega na primeira vez que você o usa e roda dentro do seu recurso, então os pontos, teclas e callbacks que você cria pertencem ao seu recurso e somem quando ele para. Classes são criadas com .new() e os métodos delas são chamados com dois-pontos: local points = aiLib.Points.new(), depois points:add(...).

client.lua
local t = aiLib.locale()

RegisterCommand('hello', function()
    aiLib.notify(t('HELLO'), 'success')
end, false)

Funções Lua marcadas com Espera (triggerServerCallback, callAction, progress, menu.show, input, skillCheck, lockpick, itemPicker, fadeOut, fadeIn, player.teleport, waitForEntity, os carregadores request*, pedHeadshot) pausam o código até a resposta chegar. Elas só funcionam dentro de uma thread. Handlers de comandos e de net events já rodam em uma; em qualquer outro lugar (o onPressed de um ponto, uma tecla, um callback de menu), envolva a chamada em CreateThread(function() ... end).

Nem todo helper de TypeScript tem um equivalente em Lua. Cada entrada informa quando não tem. Os que faltam em Lua: fromServer, isActionOk, replyError, onCache (Lua tem cache.onChange), readPlayerState, readWeapon, player.holdAnim, attachProp, PreviewVehicle, NuiScreen, hud.onChange, controls.isDisabled, medical, fuel, drivenVehicle, entityFromNetId, os helpers de props de veículo, ScriptCamera, TickLoop (use aiLib.every(0, fn)), AreaFollower, ServerClock, AdminWorld, RecordObjects, e as verificações de vínculo (hasJob, inGang, onDutyIn, allows, onMembershipChange).

Tópicos

Helpers compartilhados com o servidor

A entrada do cliente também reexporta os helpers de /fivem, então você também pode importá-los de @aicore8/lib/client. Eles são documentados uma vez em Lib: compartilhada e fivem:

registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted, createLocale, loadLocaleTexts, LOCALE_CONVAR, ByResource, caller, onStop, plateOf, Reasons, every (com os tipos EveryOptions e Job), stateBoolean, stateNumber, stateString (tipo StateParse).

As classes de state bag EntityState, PlayerState, GlobalKey e GlobalGroup exportadas pela entrada do cliente são as versões de cliente, somente leitura: get(id) e onChange(handler), sem set. As versões de servidor estão em State bags.

Exports que o seu script nunca chama

ZoneEngine (o verificador de zonas por trás de Zones), ModelScanner e readModelScanDef (a varredura de modelos por trás de Points.addModel) são exportados para o ai-lib, que os roda para todo recurso. Use Zones e Points em vez deles.

Nesta página