Sondy i wczytywanie

Pytania do gry o świat (co jest przed graczem, jak wysoko jest ziemia, jak nazywa się ta ulica) i loadery, których każdy model, animacja i efekt potrzebuje przed użyciem.

SondyCopy Anchor Link

raycastCopy Anchor Link

Sonda liniowa z odpowiedzią w tej samej klatce: w co najpierw trafia linia od from do to. Używaj jej do "na co patrzy gracz", stawiania obiektów na ziemi albo linii wzroku.

Strona: Klient · Czeka: nie (blokuje klatkę, aż test się skończy)

raycast(from: Vec3, to: Vec3, options?: RaycastOptions): RayHit | null

local hit = aiLib.raycast(from, to, options) -- tabela albo nil; from / to to vector3

ParametryCopy Anchor Link

RaycastOptionsCopy Anchor Link

Zwracana wartośćCopy Anchor Link

RayHit | null: { coords, normal, entity } dla pierwszego trafienia albo null (nil), gdy linia w nic nie trafia.

PrzykładCopy Anchor Link

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

/** What the camera looks at within 10 m. */
export function lookedAt(): number {
  const [cx = 0, cy = 0, cz = 0] = GetGameplayCamCoord();
  const [rx = 0, , rz = 0] = GetGameplayCamRot(2);
  const pitch = (rx * Math.PI) / 180;
  const yaw = (rz * Math.PI) / 180;
  const dir = { x: -Math.sin(yaw) * Math.cos(pitch), y: Math.cos(yaw) * Math.cos(pitch), z: Math.sin(pitch) };
  const hit = raycast(
    { x: cx, y: cy, z: cz },
    { x: cx + dir.x * 10, y: cy + dir.y * 10, z: cz + dir.z * 10 },
    { flags: 2 | 4 | 16 },
  );
  return hit?.entity ?? 0;
}

groundZCopy Anchor Link

Wysokość ziemi pod punktem, sondując w dół od z.

Strona: Klient · Czeka: nie

groundZ(x: number, y: number, z?: number): number | null

local ground = aiLib.groundZ(x, y, z) -- liczba albo nil

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

number | null: wysokość ziemi albo null (nil), dopóki kolizja tam nie jest wczytana (obszar jest daleko od gracza).

PrzykładCopy Anchor Link

import { groundZ, player } from "@aicore-fivem/lib/client";

const { x, y, z } = player.coords();
const ground = groundZ(x, y, z + 2);
if (ground !== null) console.log(`ground is ${(z - ground).toFixed(2)} m below`);

locationNameCopy Anchor Link

Nazwy ulicy, ulicy poprzecznej i obszaru w punkcie. Używaj ich w alertach dispatchu, wiadomościach telefonu i HUD-ach.

Strona: Klient · Czeka: nie

locationName(coords?: Vec3): LocationName

local where = aiLib.locationName(coords) -- coords to vector3, opcjonalnie

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

LocationName:

PrzykładCopy Anchor Link

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

const { street, crossing, zone } = locationName();
const text = crossing ? `${street} / ${crossing}, ${zone}` : `${street}, ${zone}`;

vehicleLabelCopy Anchor Link

Nazwa wyświetlana pojazdu (Sultan RS) z nazwy modelu, hasha modelu albo encji pojazdu.

Strona: Klient · Czeka: nie

vehicleLabel(vehicle: string | number): string

local name = aiLib.vehicleLabel(vehicle)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

string: etykieta modelu z gry; nazwa wyświetlana modelu, gdy gra nie ma dla niego tekstu (pojazdy dodatkowe bez wpisu tekstowego); nazwa albo hash modelu jako tekst, gdy brakuje nawet tego.

PrzykładCopy Anchor Link

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

onCache("vehicle", (vehicle) => {
  if (vehicle !== false && cache.seat === -1) notify(vehicleLabel(vehicle), "info", 2000);
});

waypointCopy Anchor Link

Punkt nawigacji, który gracz ustawił na mapie.

Strona: Klient · Czeka: nie

waypoint(): { x: number; y: number } | null

local target = aiLib.waypoint() -- { x, y } albo nil

Zwracana wartośćCopy Anchor Link

{ x: number; y: number } | null: pozycja punktu nawigacji (bez wysokości: punkty nawigacji na mapie jej nie mają) albo null (nil), gdy żaden punkt nie jest ustawiony.

PrzykładCopy Anchor Link

Zobacz player.teleport: teleport do punktu nawigacji.

pedHeadshotCopy Anchor Link

Robi zdjęcie głowy peda i czeka, aż gra je wyrenderuje. Używaj nazwy tekstury na stronie NUI jako https://nui-img/<txd>/<txd>.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

pedHeadshot(ped: number, transparent?: boolean, timeoutMs?: number): Promise<{ handle: number; txd: string } | null>

local handle, txd = aiLib.pedHeadshot(ped, transparent, timeout) -- wywołuj wewnątrz wątku

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<{ handle: number; txd: string } | null>: uchwyt zdjęcia i nazwa jego tekstury; null, gdy ped nie istnieje albo render trwał dłużej niż limit czasu. Lua zwraca handle, txd albo nil.

PrzykładCopy Anchor Link

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

export async function sendMugshot(): Promise<void> {
  const shot = await pedHeadshot(cache.ped, true);
  if (!shot) return;
  SendNUIMessage({ action: "photo", data: `https://nui-img/${shot.txd}/${shot.txd}` });
  setTimeout(() => UnregisterPedheadshot(shot.handle), 10_000);
}

onShotCopy Anchor Link

Uruchamia handler w klatce, w której lokalny ped oddaje strzał (stres, alerty o strzałach, łuski). Jedno sprawdzenie co klatkę na twój zasób, włączone tylko wtedy, gdy broń jest w ręku.

Strona: Klient · Czeka: nie

onShot(handler: (weapon: number) => void): () => void

aiLib.onShot(function(weapon) end) -- nic nie zwraca

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

TypeScript: () => void, funkcja, która usuwa handler. Lua nic nie zwraca (handler zostaje).

PrzykładCopy Anchor Link

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

let lastAlert = 0;
onShot(() => {
  if (GetGameTimer() - lastAlert < 30_000) return; // jeden alert na 30 s
  lastAlert = GetGameTimer();
  emitNet("mypolice:shots");
});

Wczytywanie zasobów gryCopy Anchor Link

Modele, animacje, efekty i tekstury muszą być wczytane przed użyciem. Każdy loader prosi o zasób i czeka, aż będzie gotowy. Zwolnij go, gdy skończysz, jak mówi każdy wpis.

requestModelCopy Anchor Link

Wczytuje model (ped, pojazd, obiekt) i podaje jego hash.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

requestModel(model: string | number, timeoutMs?: number): Promise<number>

local hash = aiLib.requestModel(model, timeout) -- integer albo nil, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<number>: hash modelu po wczytaniu. Odrzuca się, gdy model nie istnieje w plikach gry albo nie wczyta się na czas. Lua zwraca hash albo nil w obu przypadkach.

PrzykładCopy Anchor Link

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

export async function placeCone(x: number, y: number, z: number): Promise<number> {
  const hash = await requestModel("prop_roadcone02a");
  const cone = CreateObject(hash, x, y, z, false, false, false);
  SetModelAsNoLongerNeeded(hash);
  PlaceObjectOnGroundProperly(cone);
  return cone;
}

requestAnimDictCopy Anchor Link

Wczytuje słownik animacji.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

requestAnimDict(dict: string, timeoutMs?: number): Promise<string>

local dict = aiLib.requestAnimDict(dict, timeout) -- string albo nil, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<string>: nazwa słownika po wczytaniu. Odrzuca się, gdy słownik nie istnieje albo nie wczyta się na czas. Lua zwraca nazwę albo nil.

PrzykładCopy Anchor Link

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

export async function dance(): Promise<void> {
  const dict = await requestAnimDict("anim@amb@nightclub@dancers@crowddance_facedj@");
  TaskPlayAnim(cache.ped, dict, "hi_dance_facedj_09_v2_male^1", 8, -8, -1, 1, 0, false, false, false);
  RemoveAnimDict(dict);
}

requestAnimSetCopy Anchor Link

Wczytuje clipset ruchu (chód w kucki, chód rannego).

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

requestAnimSet(set: string, timeoutMs?: number): Promise<string>

local set = aiLib.requestAnimSet(set, timeout) -- string albo nil, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<string>: nazwa clipsetu po wczytaniu. Odrzuca się, gdy nie wczyta się na czas. Lua zwraca nazwę albo nil.

PrzykładCopy Anchor Link

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

export async function limp(): Promise<void> {
  const set = await requestAnimSet("move_m@injured");
  SetPedMovementClipset(cache.ped, set, 0.2);
}

requestPtfxAssetCopy Anchor Link

Wczytuje zasób efektu cząsteczkowego.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

requestPtfxAsset(asset: string, timeoutMs?: number): Promise<string>

local asset = aiLib.requestPtfxAsset(asset, timeout) -- string albo nil, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<string>: nazwa zasobu po wczytaniu. Odrzuca się, gdy nie wczyta się na czas. Lua zwraca nazwę albo nil.

PrzykładCopy Anchor Link

import { player, requestPtfxAsset } from "@aicore-fivem/lib/client";

export async function sparks(): Promise<void> {
  const asset = await requestPtfxAsset("core");
  const { x, y, z } = player.coords();
  UseParticleFxAsset(asset);
  StartParticleFxNonLoopedAtCoord("ent_sht_electrical_box", x, y, z, 0, 0, 0, 1, false, false, false);
  RemoveNamedPtfxAsset(asset);
}

requestTextureDictCopy Anchor Link

Wczytuje strumieniowany słownik tekstur (dla DrawSprite i podobnych).

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

requestTextureDict(dict: string, timeoutMs?: number): Promise<string>

local dict = aiLib.requestTextureDict(dict, timeout) -- string albo nil, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<string>: nazwa słownika po wczytaniu. Odrzuca się, gdy nie wczyta się na czas. Lua zwraca nazwę albo nil.

PrzykładCopy Anchor Link

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

export async function showCrosshair(): Promise<void> {
  const dict = await requestTextureDict("shared");
  every(0, () => DrawSprite(dict, "emptydot_32", 0.5, 0.5, 0.01, 0.018, 0, 255, 255, 255, 200));
}

requestWeaponAssetCopy Anchor Link

Wczytuje model i zasoby broni i podaje jej hash.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

requestWeaponAsset(weapon: string | number, timeoutMs?: number): Promise<number>

local hash = aiLib.requestWeaponAsset(weapon, timeout) -- integer albo nil, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<number>: hash broni po wczytaniu. Odrzuca się, gdy nie wczyta się na czas. Lua zwraca hash albo nil.

PrzykładCopy Anchor Link

import { player, requestWeaponAsset } from "@aicore-fivem/lib/client";

export async function showcasePistol(): Promise<number> {
  const hash = await requestWeaponAsset("WEAPON_PISTOL");
  const { x, y, z } = player.coords();
  const object = CreateWeaponObject(hash, 0, x, y, z + 1, true, 1, 0);
  RemoveWeaponAsset(hash);
  return object;
}