AI Core
API-ReferenzLib: Client

Lib: Client

@aicore8/lib/client und die Client-Seite von aiLib: was sie sind, wie du sie in TypeScript und Lua lädst, und jede Themenseite.

Die Client-Lib ist die Sammlung von Helfern, die jedes ai-*-Client-Skript nutzt, statt Natives von Hand zu schreiben: mit dem Server sprechen, der lokale Spieler, Interaktionspunkte, Zonen, Peds und Blips, die gemeinsame UI (Benachrichtigungen, Fortschrittsbalken, Menüs, Minispiele), Keybinds und die Ebenen, die über ai-core das HUD-, Death-, Kleidungs- oder Emote-Skript erreichen, das der Server betreibt.

TypeScript

Importiere aus @aicore8/lib/client in Dateien unter resource/client/. Helfer, die auf jeder Seite funktionieren (Ablehnungen, Eingabeleser, Mathematik, RecordObjects, ServerClock), kommen aus @aicore8/lib/shared.

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

Jede Ressource, die aus der ai-core-Vorlage erstellt wurde, hängt bereits von dem Paket ab ("@aicore8/lib": "workspace:*" in package.json); der Build bündelt es in dist/client.js.

Lua

Lua-Ressourcen bekommen dieselben Helfer in der globalen Tabelle aiLib aus der Ressource ai-lib. Füge zwei Zeilen in deine fxmanifest.lua ein:

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

Rufe dann aiLib.<name> in einer beliebigen Client-Datei auf. Jedes Modul lädt beim ersten Gebrauch und läuft innerhalb deiner Ressource, sodass die Punkte, Keybinds und Callbacks, die du erstellst, zu deiner Ressource gehören und verschwinden, wenn sie stoppt. Klassen werden mit .new() erstellt, und ihre Methoden werden mit einem Doppelpunkt aufgerufen: local points = aiLib.Points.new(), dann points:add(...).

client.lua
local t = aiLib.locale()

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

Lua-Funktionen, die mit Wartet markiert sind (triggerServerCallback, callAction, progress, menu.show, input, skillCheck, lockpick, itemPicker, fadeOut, fadeIn, player.teleport, waitForEntity, die request*-Lader, pedHeadshot), halten den Code an, bis die Antwort kommt. Sie funktionieren nur innerhalb eines Threads. Befehls-Handler und Net-Event-Handler laufen bereits in einem; überall sonst (das onPressed eines Punkts, ein Keybind, ein Menü-Callback) packst du den Aufruf in CreateThread(function() ... end).

Nicht jeder TypeScript-Helfer hat einen Lua-Zwilling. Jeder Eintrag sagt es, wenn er keinen hat. Diese fehlen in Lua: fromServer, isActionOk, replyError, onCache (Lua hat cache.onChange), readPlayerState, readWeapon, player.holdAnim, attachProp, PreviewVehicle, NuiScreen, hud.onChange, controls.isDisabled, medical, fuel, drivenVehicle, entityFromNetId, die Helfer für Fahrzeug-Props, ScriptCamera, TickLoop (nutze aiLib.every(0, fn)), AreaFollower, ServerClock, AdminWorld, RecordObjects und die Mitgliedschaftsprüfungen (hasJob, inGang, onDutyIn, allows, onMembershipChange).

Themen

Mit dem Server geteilte Helfer

Der Client-Einstieg exportiert auch die /fivem-Helfer erneut, sodass du sie auch aus @aicore8/lib/client importieren kannst. Sie sind einmal auf Lib: Shared und fivem dokumentiert:

registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted, createLocale, loadLocaleTexts, LOCALE_CONVAR, ByResource, caller, onStop, plateOf, Reasons, every (mit den Typen EveryOptions und Job), stateBoolean, stateNumber, stateString (Typ StateParse).

Die State-Bag-Klassen EntityState, PlayerState, GlobalKey und GlobalGroup, die der Client-Einstieg exportiert, sind die schreibgeschützten Client-Versionen: get(id) und onChange(handler), kein set. Die Server-Versionen stehen unter State Bags.

Exports, die dein Skript nie aufruft

ZoneEngine (der Zonenprüfer hinter Zones), ModelScanner und readModelScanDef (der Modellscan hinter Points.addModel) werden für ai-lib exportiert, das sie für jede Ressource ausführt. Nutze stattdessen Zones und Points.

Auf dieser Seite