Lib: общее и fivem
@aicore8/lib/shared и /fivem: помощники, которые работают на обеих сторонах, для чего нужна каждая точка входа, и все тематические страницы.
Две части lib одинаково работают и на клиенте, и на сервере:
| Точка входа | Что в ней | Где её можно использовать |
|---|---|---|
@aicore8/lib/shared | Простые помощники, которые никогда не вызывают нативы FiveM: отказы, функции чтения ввода, форматирование чисел и текста, векторная математика, геометрия зон, функции чтения данных панели, языковые тексты страницы NUI. | Код клиента, сервера, resource/common/ и NUI (React). |
@aicore8/lib/fivem | Помощники, которые вызывают нативы, существующие на обеих сторонах: экспорты между ресурсами, планировщик, обработка остановки ресурса, загрузчик языковых файлов. | Клиент, сервер и resource/common/. Не в коде NUI. |
Точки входа клиента и сервера реэкспортируют всё из /fivem, поэтому в файле клиента или сервера эти помощники можно импортировать и из @aicore8/lib/client или @aicore8/lib/server. Используйте /fivem только в файлах resource/common/, которые собираются для обеих сторон.
import { fail, readInt, groupDigits } from "@aicore8/lib/shared";
import { resourceExport, every, createLocale } from "@aicore8/lib/fivem";Lua
Лишь у немногих из этих помощников есть Lua-аналог в aiLib (загружается через shared_script '@ai-lib/init.lua', см. Lib для Lua): every, waitFor, formatText, locale, fail, numbers.round, numbers.groupDigits, numbers.headingTo и stripGameText. В каждой записи показан вызов на Lua, если он есть, и сказано, если его нет. Для остального в Lua есть свои средства: векторная математика (#(a - b) для расстояния), Entity(e).state для state bags, exports['name']:Fn() для экспортов.
Темы
Экспорты между ресурсами
registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted.
Планирование и жизненный цикл
every, onStop, caller, ByResource, Reasons, sleep, waitFor.
State bags
EntityState, PlayerState, GlobalKey, GlobalGroup и их парсеры: чтение реплицируемых значений из памяти.
Действия и ввод от клиента
ActionResult, fail, isActionOk, replyError, readInt, readText, readId, readVec3, oneArg, asArgs.
Текст и числа
formatText, round, groupDigits, formatWeight, stripGameText, randomInt, pickRandom, rollChance, ServerClock.
Позиции
distance, flatDistance, headingTo, nearestOf, gridCell, cellKey.
Транспорт
plateOf, normalizePlate, vehicleTypeOfClass, toVehicleProps, toVehicleSetup.
Данные панели
num, int, bool, str, record, vec4, spec, readRecords, RecordObjects, withoutSchemaKey.
Доступ, блипы и NPC мест
readAccess, ACCESS_FIELDS, decideAccess, readBlipStyle, readPlacePed и их поля панели.
Локализация
createLocale, loadLocaleTexts, LangTexts: языковые файлы вашего ресурса в игре и в NUI.
Логирование
createLogger, logSafe, previewJson.
Геометрия зон
ZoneShape, zoneContains, zoneBounds, polyFromCorners, readZoneShape.
Общие типы (Vec3, Vec4, ActionResult, AccessRule, BlipStyle, ZoneShape, VehicleProps...) разобраны поле за полем на странице Общие типы.
База данных
createDatabaseTables устанавливает ваш sql/main.sql при старте; WriteQueue выполняет записи в базу данных одну за другой.
Экспорты между ресурсами
registerExport, resourceExport, optionalExport, callExport, provideExport и isResourceStarted: как предлагать и вызывать экспорты из TypeScript.