Lib: compartilhada e fivem
@aicore8/lib/shared e /fivem: os helpers que funcionam nos dois lados, para que serve cada entrada, e todas as páginas de tópicos.
Duas partes da lib funcionam tanto no cliente quanto no servidor:
| Entrada | O que contém | Onde você pode usar |
|---|---|---|
@aicore8/lib/shared | Helpers simples que nunca chamam uma native do FiveM: recusas, leitores de entrada, formatação de números e textos, matemática de vetores, geometria de zonas, leitores de dados do painel, os textos de idioma de uma página NUI. | Código de cliente, de servidor, de resource/common/ e de NUI (React). |
@aicore8/lib/fivem | Helpers que chamam natives existentes nos dois lados: exports entre recursos, o agendador, o tratamento da parada do recurso, o carregador do arquivo de idioma. | Cliente, servidor e resource/common/. Não em código de NUI. |
As entradas de cliente e de servidor reexportam tudo de /fivem, então em um arquivo de cliente ou de servidor você também pode importar esses helpers de @aicore8/lib/client ou @aicore8/lib/server. Use /fivem só em arquivos de resource/common/ que os dois lados empacotam.
import { fail, readInt, groupDigits } from "@aicore8/lib/shared";
import { resourceExport, every, createLocale } from "@aicore8/lib/fivem";Lua
Só alguns destes helpers têm um equivalente em Lua no aiLib (carregue-o com shared_script '@ai-lib/init.lua', veja Lib para Lua): every, waitFor, formatText, locale, fail, numbers.round, numbers.groupDigits, numbers.headingTo e stripGameText. Cada entrada mostra a chamada Lua quando existe, e informa quando não existe. Lua tem as próprias ferramentas para o resto: matemática de vetores (#(a - b) para uma distância), Entity(e).state para state bags, exports['name']:Fn() para exports.
Tópicos
Exports entre recursos
registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted.
Agendamento e ciclo de vida
every, onStop, caller, ByResource, Reasons, sleep, waitFor.
State bags
EntityState, PlayerState, GlobalKey, GlobalGroup e os parsers deles: ler valores replicados da memória.
Ações e entrada do cliente
ActionResult, fail, isActionOk, replyError, readInt, readText, readId, readVec3, oneArg, asArgs.
Textos e números
formatText, round, groupDigits, formatWeight, stripGameText, randomInt, pickRandom, rollChance, ServerClock.
Posições
distance, flatDistance, headingTo, nearestOf, gridCell, cellKey.
Veículos
plateOf, normalizePlate, vehicleTypeOfClass, toVehicleProps, toVehicleSetup.
Dados do painel
num, int, bool, str, record, vec4, spec, readRecords, RecordObjects, withoutSchemaKey.
Acesso, blips e NPCs de lugares
readAccess, ACCESS_FIELDS, decideAccess, readBlipStyle, readPlacePed e os campos de painel deles.
Idioma
createLocale, loadLocaleTexts, LangTexts: os arquivos de idioma do seu recurso no jogo e na NUI.
Logging
createLogger, logSafe, previewJson.
Geometria de zonas
ZoneShape, zoneContains, zoneBounds, polyFromCorners, readZoneShape.
Os tipos compartilhados (Vec3, Vec4, ActionResult, AccessRule, BlipStyle, ZoneShape, VehicleProps...) são explicados campo por campo em Tipos compartilhados.
Banco de dados
createDatabaseTables instala o seu sql/main.sql na inicialização; WriteQueue executa as escritas no banco uma depois da outra.
Exports entre recursos
registerExport, resourceExport, optionalExport, callExport, provideExport e isResourceStarted: oferecer e chamar exports a partir de TypeScript.