AI Core
API-ReferenzAI Core: Server-Exports

Server-Exports

Wie du die Server-Exports von ai-core aus Lua und TypeScript aufrufst, und die Liste aller Export-Gruppen.

ai-core ist die Framework-Ressource. Andere Ressourcen fragen es nach dem Charakter, dem Geld, den Jobs und den Items eines Spielers und schicken ihm Aufgaben wie „gib diesem Spieler einen Schlüssel“ oder „sende einen Polizeialarm“. Das tun sie über Exports: Funktionen, die ai-core für jede andere Ressource auf dem Server aufrufbar macht.

Diese Seiten listen jeden Server-Export, den ai-core registriert, nach Thema gruppiert. Jeder Eintrag zeigt, was der Export tut, seine genaue Signatur, jeden Parameter, was er in jedem Fall zurückgibt, und ein funktionierendes Beispiel in TypeScript und Lua.

Einen Export aufrufen

Ein Export wird über den Namen der Ressource, der er gehört (ai-core), und den Namen des Exports aufgerufen.

import { resourceExport } from "@aicore8/lib/server";

// Ein typisiertes Handle pro Datei, ganz oben. Das ist hier sicher: FiveM sucht
// jeden Export beim ersten Aufruf und vergisst ihn, wenn ai-core neu startet.
const core = resourceExport("ai-core");

export function cashOf(source: number): number {
  return core.GetMoney(source, "cash") ?? 0;
}

Was du vor dem Start wissen solltest:

  • TypeScript-Typen. resourceExport("ai-core") ist über AiCoreServerExports in @aicore8/shared typisiert, sodass dein Editor jeden Namen, Parameter und Rückgabetyp kennt. Schreibe nie resourceExport("ai-core").GetMoney(...) innerhalb einer Funktion: Behalte das eine Handle oben in der Datei.
  • Lua nutzt einen Doppelpunkt. Schreibe exports['ai-core']:GetMoney(source, 'cash'), keinen Punkt. Eine null-Antwort kommt in Lua als nil an, ein Array als Lua-Liste (Index 1 zuerst), ein Objekt als Tabelle.
  • Zwei Schreibweisen. Jeder Export antwortet auch mit vertauschter Groß-/Kleinschreibung des ersten Buchstabens: GetMoney und getMoney sind dieselbe Funktion.
  • Exports warten nie. Jeder Export antwortet sofort mit einem kleinen Wert. Braucht die Antwort die Datenbank (ein gespeichertes Aussehen, eine Liste von Rechnungen), nimmt der Export einen done-Callback, statt ein Promise zurückzugeben, denn ein Promise kann nicht von einer Ressource in eine andere wechseln.
  • Nicht in heißen Pfaden. Ein Export-Aufruf kopiert seine Argumente und seine Antwort. Rufe Exports nicht in jedem Frame oder für jeden Spieler in einer Schleife auf. Für „wer ist im Dienst“, den Namen eines Charakters oder Jobs über viele Spieler hinweg nutzt du den online-Spiegel der Lib, der den Events von ai-core folgt (Lib: Server).
  • ai-core muss zuerst laufen. Schreibe dependency 'ai-core' in deine fxmanifest.lua (eine ai-*-Ressource listet es in package.json unter fxDependencies), damit deine Ressource nach ai-core startet.
  • source ist die Server-ID des Spielers. Das ist die Zahl, die FiveM einem verbundenen Spieler gibt. Eine Charakter-ID (charId) ist eine andere Zahl: die ID der Charakterzeile in der Datenbank.

Die Lib oder der Export?

Die meisten Exports haben einen Wrapper in @aicore8/lib/server (und viele in Luas aiLib). Der Wrapper ruft denselben Export auf, das Verhalten ist also identisch; er liest sich nur schöner (inventory.addItem(source, "water") statt core.AddItem(source, "water")) und macht aus Callbacks Promises, wo das sicher ist. Jeder Eintrag nennt seinen Wrapper in der Zeile Lib. Nutze, was dir lieber ist; eine Lua-Ressource ohne ai-lib ruft den Export direkt auf.

Beispiele auf diesen Seiten

Die Beispiele sind vollständige Server-Dateien. TypeScript-Beispiele nutzen addCommand und onClientCallback der Lib; Lua-Beispiele nutzen aiLib.addCommand und aiLib.onClientCallback von ai-lib, die diese Zeilen in deiner fxmanifest.lua brauchen:

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

Wartende Lua-Aufrufe (aiLib.progressFor, Wait) funktionieren nur innerhalb eines Threads; Befehls- und Callback-Handler laufen bereits in einem.

Typen

Typen, die auf mehreren Seiten vorkommen (CharacterInfo, InventoryRef, DispatchAlert...), sind einmal mit jedem Feld auf der Seite Typen dokumentiert und von jedem Eintrag verlinkt, der sie nutzt.

Export-Gruppen

Charaktere und Spieler

Spielerdaten, Charaktere, Abfragen per Server-ID, Charakterwechsel, Offline-Positionen, Spieler in Reichweite.

Gespeicherte Charaktere

Jeder Charakter, geladen oder nicht: finden, lesen, Geld, Jobs, Gangs, Metadaten, Name, Spielzeit, speichern, löschen.

Geld und Konten

Kontostände, Geld hinzufügen und abziehen, Job- und Gang-Konten, Überweisungen, Kontotypen.

Jobs und Gangs

Mitgliedschaften, Dienst, Ränge, Anzahl im Dienst, Prime Time, Job- und Gang-Definitionen.

Metadaten und Einstellungen

Der Metadaten-Beutel eines Charakters, das Branding des Servers, veraltete Skripte.

Items

Items hinzufügen, entfernen, zählen und prüfen, Lager, Skript-Shops, benutzbare Items, Item-Definitionen.

Fahrzeugschlüssel

Fahrzeugschlüssel geben, entfernen und prüfen, über das laufende Schlüssel-Skript.

Kraftstoff

Den Tankstand eines Fahrzeugs lesen und setzen, über das laufende Tank-Skript.

Türschlösser

Türen ab- und aufschließen und lesen, über das laufende Türschloss-Skript.

Garagen

Beschlagnahmen, einparken, ein Garagenmenü öffnen, die eingeparkten Fahrzeuge eines Spielers auflisten.

Medizin

Wiederbeleben, heilen und prüfen, ob ein Spieler am Boden ist.

EMS

Wie viele Sanitäter frei sind, Notrufe.

Aussehen

Das gespeicherte Aussehen eines Charakters aus dem laufenden Kleidungs-Skript.

Handy

Telefonnummern, Mails, Textnachrichten und Handy-Benachrichtigungen.

Dispatch

Polizei- und Job-Alarme über das laufende Alarmsystem.

MDT

Bußgelder, Haftbefehle, Festnahmen und Haftakten im Polizei-MDT.

Gefängnis

Einsperren, freilassen und Restzeit.

Bank

Einen Bankbildschirm öffnen, der Firmenkontostand eines Jobs.

Rechnungen

Rechnungen senden, die offenen Rechnungen eines Spielers auflisten und bezahlen.

Stress und Bedürfnisse

Stress hinzufügen oder abbauen, Hunger und Durst auffüllen.

Zeit und Wetter

Wetter, Spielzeit, Blackout und eingefrorene Zeit.

Routing-Buckets

Einen freien Routing-Bucket für eine separate Welt nehmen und zurückgeben.

Logs

Logs an Discord, Fivemanage, FiveM Stats und die Konsole senden.

Verbindungsprüfungen

Prüfungen, die jeder verbindende Spieler besteht, Skripte, die andere ersetzen.

Admin-Panel und Befehle

Panel-Registrierung, der Tab Commands, Nachschlagelisten, externe Einstellungsbildschirme.

vRP-Brücke

Exports, die die eingebaute vRP-Brücke von ai-core nutzt.

Verwandte Seiten

  • Client-Exports: was ai-core im eigenen Spiel des Spielers beantwortet.
  • Events und Zustand: die Events, die ai-core auslöst (ai-core:playerLoaded, ai-core:moneyChanged...), mit denen deine Ressource Änderungen folgt, statt erneut zu fragen.
  • Lib: Server: die Wrapper, die jeder Eintrag nennt.

Auf dieser Seite