Ebenen über ai-core

Diese Objekte sprechen nie mit einem bestimmten Skript. Sie fragen ai-core, und ai-core leitet an das Skript weiter, das der Server für diese Aufgabe betreibt: ai-death oder ein anderes Death-Skript, ai-appearance oder tgiann-clothing, jedes unterstützte Emote- oder Radial-Skript. Dein Skript funktioniert weiter, wenn der Betreiber eins austauscht. Wie die Ebenen funktionieren, steht unter Ebenen und die Brücke.

Wenn kein Skript dieser Art läuft, antworten die Aufrufe mit false, null oder dem eigenen Wert des Spiels, wie jeder Eintrag sagt.

medicalCopy Anchor Link

medical.isDeadCopy Anchor Link

Ob der lokale Spieler am Boden ist (tot oder im Last Stand), in dem Death-Skript, das gerade läuft. Death-Skripte halten einen bewusstlosen Ped am Leben, um ihn zu animieren, daher übersieht IsEntityDead allein sie. Nach dem ersten Aufruf ein Speicherzugriff.

Seite: Client · Wartet: nein

medical.isDead(): boolean

Kein Lua-Zwilling: Rufe exports['ai-core']:IsDead() auf und höre auf das lokale Event ai-core:client:dead (dead).

RückgabewertCopy Anchor Link

boolean: true, wenn die Medical-Ebene von ai-core sagt, dass der Spieler am Boden ist, oder der Ped für das Spiel tot ist.

BeispielCopy Anchor Link

import { medical, notify } from "@aicore-fivem/lib/client";

RegisterCommand(
  "phone",
  () => {
    if (medical.isDead()) return notify("You cannot use the phone now", "error");
    SetNuiFocus(true, true);
  },
  false,
);

medical.onChangeCopy Anchor Link

Führt einen Handler aus, wenn der lokale Spieler zu Boden geht oder aufsteht.

Seite: Client · Wartet: nein

medical.onChange(fn: (dead: boolean) => void): void

Kein Lua-Zwilling: AddEventHandler('ai-core:client:dead', function(dead) end).

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

import { medical, Points } from "@aicore-fivem/lib/client";

const points = new Points();
medical.onChange(() => points.refresh()); // Punkte, deren canShow medical.isDead() liest

appearanceCopy Anchor Link

Aussehen auf Peds über die Aussehens-Ebene von ai-core, egal welches Kleidungs-Skript läuft.

appearance.applyCopy Anchor Link

Legt ein gespeichertes Aussehen auf einen Ped mit dem Modell des Aussehens. Hole das Aussehen auf dem Server mit appearance.get(charId), erstelle den Ped mit look.model und wende es dann an. Auf dem eigenen Ped des Spielers ändert es seine Kleidung.

Seite: Client · Wartet: nein

appearance.apply(ped: number, look: CharacterAppearance): boolean

local ok = aiLib.appearance.apply(ped, look)

ParameterCopy Anchor Link

Der Typ ist CharacterAppearance.

RückgabewertCopy Anchor Link

boolean: false, wenn der Ped verschwunden ist, das Modell abweicht oder kein Kleidungs-Skript läuft.

BeispielCopy Anchor Link

import { appearance, LocalPed, triggerServerCallback } from "@aicore-fivem/lib/client";
import type { CharacterAppearance } from "@aicore-fivem/shared";

// Eine schlafende Kopie eines Charakters, gekleidet wie er.
export async function showSleeper(charId: number): Promise<void> {
  const look = (await triggerServerCallback("mysleep:look", [charId]).catch(() => null)) as CharacterAppearance | null;
  if (!look) return;
  new LocalPed({
    model: look.model,
    coords: { x: 151.2, y: -1004.6, z: 29.4, heading: 90 },
    onSpawn: (ped) => appearance.apply(ped, look),
  });
}

appearance.readCopy Anchor Link

Das Aussehen, das ein Ped gerade trägt.

Seite: Client · Wartet: nein

appearance.read(ped: number): CharacterAppearance | null

local look = aiLib.appearance.read(ped) -- table oder nil

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

CharacterAppearance | null: das Aussehen, oder null (nil in Lua), wenn das Kleidungs-Skript es nicht sagen kann oder keins läuft.

BeispielCopy Anchor Link

import { appearance, cache } from "@aicore-fivem/lib/client";

const before = appearance.read(cache.ped); // später mit appearance.apply wiederherstellen

appearance.openMenuCopy Anchor Link

Öffnet den Kleidungsladen, den Friseur oder die gespeicherten Outfits des Kleidungs-Skripts für den Spieler.

Seite: Client · Wartet: nein

appearance.openMenu(menu: ClothingMenu): boolean

local ok = aiLib.appearance.openMenu(menu)

ParameterCopy Anchor Link

Der Typ ist ClothingMenu.

RückgabewertCopy Anchor Link

boolean: false, wenn das Kleidungs-Skript kein solches Menü hat oder keins läuft.

BeispielCopy Anchor Link

import { appearance, Points } from "@aicore-fivem/lib/client";

const points = new Points();
points.add("barber", {
  coords: { x: -814.3, y: -183.8, z: 37.6 },
  label: "Barber",
  onPressed: () => appearance.openMenu("barber"),
});

appearance.wearOutfitCopy Anchor Link

Legt dem Spieler ein Job-Outfit (eine Uniform) an, bis reloadSkin. Es wird nicht gespeichert: Ein Reconnect oder reloadSkin gibt dem Spieler seine eigene Kleidung zurück. Nur die aufgeführten Teile ändern sich.

Seite: Client · Wartet: nein

appearance.wearOutfit(outfit: JobOutfit): boolean

local ok = aiLib.appearance.wearOutfit(outfit)

ParameterCopy Anchor Link

Die Typen sind JobOutfit und OutfitPiece.

RückgabewertCopy Anchor Link

boolean: false, wenn es nicht geht (kein Kleidungs-Skript, ein Modell, das es nicht unterstützt).

BeispielCopy Anchor Link

import { appearance } from "@aicore-fivem/lib/client";

appearance.wearOutfit({
  components: [
    { id: 11, collection: "", index: 55, texture: 0 },
    { id: 4, collection: "", index: 35, texture: 0 },
  ],
  props: [{ id: 0, collection: "", index: -1, texture: 0 }],
});

appearance.reloadSkinCopy Anchor Link

Legt dem Spieler wieder sein gespeichertes Aussehen an (zieht ein Job-Outfit aus).

Seite: Client · Wartet: nein

appearance.reloadSkin(): boolean

local ok = aiLib.appearance.reloadSkin()

RückgabewertCopy Anchor Link

boolean: false ohne Kleidungs-Skript.

BeispielCopy Anchor Link

import { appearance } from "@aicore-fivem/lib/client";

RegisterCommand("offduty", () => appearance.reloadSkin(), false);

gesturesCopy Anchor Link

Hände hoch, Zeigen und Emotes des jeweils laufenden Emote-Skripts, über ai-core.

gestures.isHandsUpCopy Anchor Link

Ob der lokale Spieler die Hände oben hat.

Seite: Client · Wartet: nein

gestures.isHandsUp(): boolean

local up = aiLib.gestures.isHandsUp()

RückgabewertCopy Anchor Link

boolean: true, solange die Hände im laufenden Emote-Skript oben sind.

BeispielCopy Anchor Link

import { gestures, onServerCallback } from "@aicore-fivem/lib/client";

// Der Server fragt vor einem Raub, ob sich das Opfer ergeben hat.
onServerCallback("myrob:surrendered", () => gestures.isHandsUp());

gestures.isPointingCopy Anchor Link

Ob der lokale Spieler zeigt.

Seite: Client · Wartet: nein

gestures.isPointing(): boolean

local pointing = aiLib.gestures.isPointing()

RückgabewertCopy Anchor Link

boolean: true, solange er zeigt.

BeispielCopy Anchor Link

if (gestures.isPointing()) return; // kein Emote über das Zeigen starten

gestures.providerCopy Anchor Link

Das Emote-Skript, das Hände hoch und Zeigen beantwortet.

Seite: Client · Wartet: nein

gestures.provider(): string | null

local name = aiLib.gestures.provider()

RückgabewertCopy Anchor Link

string | null: sein Ressourcenname, oder null (nil), wenn keins läuft.

BeispielCopy Anchor Link

console.log(`hands up from ${gestures.provider() ?? "nothing"}`);

gestures.playEmoteCopy Anchor Link

Spielt ein Emote nach seinem Befehlsnamen (was Spieler nach e eingeben) im laufenden Emote-Skript ab.

Seite: Client · Wartet: nein

gestures.playEmote(name: string): boolean

local ok = aiLib.gestures.playEmote(name)

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

boolean: false ohne Emote-Skript.

BeispielCopy Anchor Link

import { gestures } from "@aicore-fivem/lib/client";

RegisterCommand("hi", () => gestures.playEmote("wave"), false);

gestures.cancelEmoteCopy Anchor Link

Stoppt das Emote, das der Spieler abspielt (gefesselt, niedergeschlagen).

Seite: Client · Wartet: nein

gestures.cancelEmote(): boolean

local ok = aiLib.gestures.cancelEmote()

RückgabewertCopy Anchor Link

boolean: false ohne Emote-Skript.

BeispielCopy Anchor Link

onServerEvent("mypolice:cuffed", () => gestures.cancelEmote());

gestures.emoteProviderCopy Anchor Link

Das Emote-Skript, das Emotes abspielt (es kann sich von dem unterscheiden, das Hände hoch beantwortet).

Seite: Client · Wartet: nein

gestures.emoteProvider(): string | null

local name = aiLib.gestures.emoteProvider()

RückgabewertCopy Anchor Link

string | null: sein Ressourcenname, oder null (nil), wenn keins läuft.

BeispielCopy Anchor Link

if (gestures.emoteProvider() === null) console.log("no emote script: skipping the emote");

seatbeltCopy Anchor Link

Der Sicherheitsgurt des lokalen Spielers über ai-core, egal welches Gurt-Skript läuft.

seatbelt.isOnCopy Anchor Link

Ob der Gurt angelegt ist. Frage bei Bedarf, nicht in jedem Frame.

Seite: Client · Wartet: nein

seatbelt.isOn(): boolean | null

local worn = aiLib.seatbelt.isOn() -- boolean oder nil

RückgabewertCopy Anchor Link

boolean | null: true oder false; null (nil), wenn kein Gurt-Skript antwortet.

BeispielCopy Anchor Link

import { cache, notify, onCache, seatbelt } from "@aicore-fivem/lib/client";

onCache("vehicle", (vehicle) => {
  if (vehicle !== false && seatbelt.isOn() === false) notify("Buckle up", "warning");
});

seatbelt.onChangeCopy Anchor Link

Führt einen Handler aus, wenn sich der Gurt ändert. Nur Gurt-Skripte, die Änderungen melden, lösen ihn aus.

Seite: Client · Wartet: nein

seatbelt.onChange(fn: (worn: boolean | null) => void): void

aiLib.seatbelt.onChange(function(worn) end)

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

seatbelt.onChange((worn) => SendNUIMessage({ action: "belt", data: worn === true }));

seatbelt.providerCopy Anchor Link

Das Gurt-Skript, das antwortet.

Seite: Client · Wartet: nein

seatbelt.provider(): string | null

local name = aiLib.seatbelt.provider()

RückgabewertCopy Anchor Link

string | null: sein Ressourcenname, oder null (nil), wenn keins antwortet.

BeispielCopy Anchor Link

if (seatbelt.provider() === null) console.log("no seat belt script runs");

fuelCopy Anchor Link

fuel.getCopy Anchor Link

Der Spritstand eines Fahrzeugs. Der Server hält für jedes Fahrzeug einen State Bag fuel, egal welches Sprit-Skript läuft, daher ist dies ein Speicherzugriff; ohne diesen Bag ist es der Tankstand des Spiels.

Seite: Client · Wartet: nein

fuel.get(vehicle: number): number

Kein Lua-Zwilling: Lies Entity(vehicle).state.fuel. Sprit setzen geht nur auf dem Server (fuel.set auf Fahrzeuge).

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

number: 0-100.

BeispielCopy Anchor Link

import { cache, every, fuel } from "@aicore-fivem/lib/client";

every(1000, () => {
  if (cache.vehicle !== false) SendNUIMessage({ action: "fuel", data: Math.round(fuel.get(cache.vehicle)) });
});

mdtCopy Anchor Link

mdt.openCopy Anchor Link

Öffnet das aktive Polizei-MDT für den lokalen Spieler. Das MDT prüft den Job selbst.

Seite: Client · Wartet: nein

mdt.open(): boolean

local ok = aiLib.mdt.open()

RückgabewertCopy Anchor Link

boolean: false, wenn kein MDT läuft oder es nicht von außen geöffnet werden kann.

BeispielCopy Anchor Link

import { mdt, notify } from "@aicore-fivem/lib/client";

RegisterCommand("mdt", () => {
  if (!mdt.open()) notify("No MDT available", "error");
}, false);

radialCopy Anchor Link

Einträge im jeweils laufenden Radialmenü (ai-radialmenu, oder ein anderes über die Radial-Ebene von ai-core). ai-core behält sie über Neustarts des Radialmenüs hinweg und entfernt sie, wenn deine Ressource stoppt: einmal beim Start hinzufügen.

radial.addCopy Anchor Link

Fügt dem Rad einen Eintrag hinzu oder ersetzt den Eintrag mit derselben ID.

Seite: Client · Wartet: nein

radial.add(item: RadialItem): void

aiLib.radial.add(item)

ParameterCopy Anchor Link

RadialItemCopy Anchor Link

Der Typ ist RadialItem.

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

import { cache, createLocale, hasJob, radial } from "@aicore-fivem/lib/client";
import { RADIAL_VEHICLE } from "@aicore-fivem/shared";

const Locale = createLocale<typeof import("../../locales/en.json")>();

radial.add({
  id: "myscript:engine",
  label: Locale("ENGINE"),
  icon: "power-off",
  parent: RADIAL_VEHICLE,
  keepOpen: true,
  canShow: () => cache.seat === -1,
  onPressed: () => {
    if (cache.vehicle === false) return;
    SetVehicleEngineOn(cache.vehicle, !GetIsVehicleEngineRunning(cache.vehicle), false, true);
  },
});

radial.add({
  id: "myscript:police",
  label: Locale("POLICE"),
  icon: "shield-halved",
  canShow: () => hasJob(["police"]),
  items: [
    { id: "myscript:cuff", label: Locale("CUFF"), icon: "handcuffs", onPressed: () => emitNet("mypolice:cuff") },
  ],
});

radial.removeCopy Anchor Link

Entfernt einen deiner Einträge. Eine unbekannte ID tut nichts.

Seite: Client · Wartet: nein

radial.remove(id: string): void

aiLib.radial.remove(id)

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

radial.remove("myscript:engine");

radial.refreshCopy Anchor Link

Liest jedes canShow eines offenen Rads erneut. Rufe es auf, nachdem sich etwas geändert hat, das sie lesen, während das Rad offen sein könnte.

Seite: Client · Wartet: nein

radial.refresh(): void

aiLib.radial.refresh()

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

onMembershipChange(() => radial.refresh());

worldCopy Anchor Link

Die Wetter- und Zeitsynchronisation des jeweils laufenden Wetter-Skripts, pausiert, solange ein Grund besteht.

world.pauseSyncCopy Anchor Link

Pausiert die Wetter- und Zeitsynchronisation aus einem Grund: in einem Interieur, während einer Szene oder während dein Skript sein eigenes Wetter setzt.

Seite: Client · Wartet: nein

world.pauseSync(reason: string): void

aiLib.world.pauseSync(reason)

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

import { world } from "@aicore-fivem/lib/client";

export function enterApartment(): void {
  world.pauseSync("apartment");
  NetworkOverrideClockTime(12, 0, 0);
  SetWeatherTypeNowPersist("EXTRASUNNY");
}

export function leaveApartment(): void {
  world.resumeSync("apartment");
}

world.resumeSyncCopy Anchor Link

Entfernt einen Pausengrund; die Synchronisation läuft wieder, wenn kein Grund übrig ist.

Seite: Client · Wartet: nein

world.resumeSync(reason: string): void

aiLib.world.resumeSync(reason)

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void. Siehe das Beispiel bei world.pauseSync.

inventoryCopy Anchor Link

Das Inventar des lokalen Spielers über die Inventar-Ebene von ai-core: Das Inventar, das der Server gewählt hat, antwortet. Items geben und nehmen geht nur auf dem Server (Items).

inventory.openInventoryCopy Anchor Link

Öffnet den eigenen Inventarbildschirm des Spielers.

Seite: Client · Wartet: nein

inventory.openInventory(): void

aiLib.inventory.openInventory()

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

import { inventory } from "@aicore-fivem/lib/client";

RegisterCommand("bag", () => inventory.openInventory(), false);

inventory.hasItemCopy Anchor Link

Ob der Spieler mindestens count Stück eines Items hat. Nutze es in canShow, damit der Spieler nur sieht, was er tun kann; der Server prüft erneut.

Seite: Client · Wartet: nein

inventory.hasItem(item: string, count?: number): boolean

local has = aiLib.inventory.hasItem(item, count)

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

boolean: true, wenn der Spieler genug hat.

BeispielCopy Anchor Link

import { inventory, Points } from "@aicore-fivem/lib/client";

const points = new Points();
points.addVehicle("lockpick", {
  label: "Lockpick",
  icon: "unlock",
  canShow: (vehicle) => GetVehicleDoorLockStatus(vehicle) >= 2 && inventory.hasItem("lockpick"),
  onPressed: (vehicle) => emitNet("mykeys:lockpick", NetworkGetNetworkIdFromEntity(vehicle)),
});

inventory.currentWeaponCopy Anchor Link

Das Waffen-Item in der Hand des Spielers: sein Name, Label und Bild.

Seite: Client · Wartet: nein

inventory.currentWeapon(): HeldWeapon | null

local weapon = aiLib.inventory.currentWeapon() -- table oder nil

RückgabewertCopy Anchor Link

HeldWeapon { name: string; label: string; image?: string } (name wie WEAPON_PISTOL, image eine nui://-URL, wenn das Inventar eine hat), oder null (nil), wenn die Hand leer ist.

BeispielCopy Anchor Link

import { inventory, onCache } from "@aicore-fivem/lib/client";

// Lies es, wenn sich die Waffe ändert, nie in jedem Frame.
onCache("weapon", () => SendNUIMessage({ action: "weapon", data: inventory.currentWeapon() }));