ai-vehicles dla deweloperów

ai-vehicles ma tylko eksporty serwera. Wszystkie są synchroniczne (bez Promise, bez czekania w Lua), z wyjątkiem SpawnVehicle, który odpowiada przez callback. Typy są w @aicore-fivem/shared (vehicles.ts).

import { resourceExport } from "@aicore-fivem/lib/server";
const vehicles = resourceExport("ai-vehicles");

local vehicles = exports['ai-vehicles']

TypyCopy Anchor Link

VehicleOwnerCopy Anchor Link

Kto jest właścicielem pojazdu.

OwnedVehicleCopy Anchor Link

Co zwracają GetVehicle i GetVehicles.

Eksporty serweraCopy Anchor Link

CreateVehicleCopy Anchor Link

Rejestruje nowy posiadany pojazd i go parkuje. Używaj, gdy gracz dostaje pojazd (zakup, nagroda, prezent od administratora). Nie tworzy auta w świecie: wyjmij je przez SpawnVehicle albo pozwól graczowi odebrać je w garażu.

Strona: serwer · Czeka: nie

CreateVehicle(owner: VehicleOwner, model: string, garage: string | null, props?: VehicleProps): { id: number; plate: string } | null

local created = exports['ai-vehicles']:CreateVehicle(owner, model, garage, props) -- { id = number, plate = string } albo nil

ParametryCopy Anchor Link

ZwracaCopy Anchor Link

{ id, plate } nowego pojazdu. null, gdy owner nie jest prawidłowym właścicielem albo model nie jest tekstem.

PrzykładCopy Anchor Link

import { resourceExport } from "@aicore-fivem/lib/server";

const core = resourceExport("ai-core");
const vehicles = resourceExport("ai-vehicles");

// Daje graczowi Sultana zaparkowanego w garażu Motel Parking.
export function giveSultan(source: number): string | null {
  const character = core.GetCharacter(source);
  if (!character) return null;
  const created = vehicles.CreateVehicle(
    { type: "character", id: String(character.id) },
    "sultan",
    "pillbox",
  );
  return created?.plate ?? null;
}

GetVehicleCopy Anchor Link

Znajduje jeden posiadany pojazd według ID lub tablicy.

Strona: serwer · Czeka: nie

GetVehicle(ref: number | string): OwnedVehicle | null

local vehicle = exports['ai-vehicles']:GetVehicle(ref) -- tabela lub nil

ParametryCopy Anchor Link

ZwracaCopy Anchor Link

OwnedVehicle albo null, gdy żaden pojazd w pamięci nie ma tego ID lub tablicy (także gdy należy do postaci offline).

PrzykładCopy Anchor Link

const vehicle = vehicles.GetVehicle("AI00001A");
if (vehicle) console.log(vehicle.model, vehicle.state, vehicle.fuel);

GetVehiclesCopy Anchor Link

Każdy pojazd jednego właściciela.

Strona: serwer · Czeka: nie

GetVehicles(owner: VehicleOwner): OwnedVehicle[]

local list = exports['ai-vehicles']:GetVehicles(owner) -- tablica

ParametryCopy Anchor Link

ZwracaCopy Anchor Link

Tablica OwnedVehicle. Pusta dla nieprawidłowego właściciela, właściciela bez pojazdów lub postaci offline.

PrzykładCopy Anchor Link

const fleet = vehicles.GetVehicles({ type: "job", id: "police" });
const parked = fleet.filter((v) => v.state === "garage").length;
console.log(`police: ${parked} of ${fleet.length} cars parked`);

IsOwnedPlateCopy Anchor Link

Czy tablica należy do posiadanego pojazdu w pamięci.

Strona: serwer · Czeka: nie

IsOwnedPlate(plate: string): boolean

local owned = exports['ai-vehicles']:IsOwnedPlate(plate)

ZwracaCopy Anchor Link

true, gdy posiadany pojazd ma tę tablicę. false dla nieznanej tablicy, wartości, która nie jest tekstem, lub pojazdu postaci offline.

GetVehicleIdByEntityCopy Anchor Link

ID w ai-vehicles utworzonego w świecie posiadanego pojazdu.

Strona: serwer · Czeka: nie

GetVehicleIdByEntity(entity: number): number | null

local id = exports['ai-vehicles']:GetVehicleIdByEntity(entity)

ParametryCopy Anchor Link

ZwracaCopy Anchor Link

ID pojazdu albo null, gdy encja nie jest posiadanym pojazdem utworzonym przez ai-vehicles.

GetEntityCopy Anchor Link

Encja utworzonego w świecie posiadanego pojazdu.

Strona: serwer · Czeka: nie

GetEntity(id: number): number | null

local entity = exports['ai-vehicles']:GetEntity(id)

ZwracaCopy Anchor Link

Uchwyt encji po stronie serwera albo null, gdy pojazd nie jest na zewnątrz lub jego encja już nie istnieje.

GetPlateOwnersCopy Anchor Link

Każdy posiadany pojazd w pamięci jako [plate, ownerType, ownerId]. Skrypt, który musi sprawdzać wiele tablic (system kluczy), czyta to raz przy starcie, a potem śledzi zdarzenie ai-vehicles:owners, zamiast wywoływać eksport przy każdym sprawdzeniu.

Strona: serwer · Czeka: nie

GetPlateOwners(): Array<[plate: string, type: VehicleOwnerType, id: string]>

local owners = exports['ai-vehicles']:GetPlateOwners() -- { { plate, type, id }, ... }

ZwracaCopy Anchor Link

Tablica trójek. Pusta, gdy w pamięci nie ma żadnego pojazdu.

SaveVehicleCopy Anchor Link

Zapisuje stan i wygląd pojazdu: paliwo, uszkodzenia, stan, garaż i props (kolory, dodatki, brud). Zapisany tuning (mods, neon) nigdy się tu nie zmienia, więc wygląd odczytany z klienta gracza nie może zapisać pracy menu modów. Do tuningu używaj SaveTuning.

Strona: serwer · Czeka: nie

SaveVehicle(id: number, change: { props?: VehicleProps; fuel?: number; engine?: number; body?: number; state?: VehicleState; garage?: string | null }): void

exports['ai-vehicles']:SaveVehicle(id, change)

ParametryCopy Anchor Link

changeCopy Anchor Link

ZwracaCopy Anchor Link

Nic. Nieznane ID nic nie robi.

PrzykładCopy Anchor Link

// Naprawa zakończona: pełny silnik i karoseria.
vehicles.SaveVehicle(vehicleId, { engine: 1000, body: 1000 });

SaveTuningCopy Anchor Link

Zapisuje pełne props, łącznie z tuningiem (mods, neon). Przeznaczony tylko dla warsztatów tuningowych: własny warsztat tuningowy AI Core, ai-mechanic, to jedyny skrypt ai-*, który go wywołuje.

Strona: serwer · Czeka: nie

SaveTuning(id: number, props: VehicleProps): void

exports['ai-vehicles']:SaveTuning(id, props)

ZwracaCopy Anchor Link

Nic. Nieprawidłowe props są ignorowane. Tablica w props jest zawsze zastępowana własną tablicą pojazdu.

StoreVehicleCopy Anchor Link

Parkuje pojazd: usuwa jego encję, jeśli jest na zewnątrz, i ustawia jego stan i garaż.

Strona: serwer · Czeka: nie

StoreVehicle(id: number, garage: string | null, state?: VehicleState): void

exports['ai-vehicles']:StoreVehicle(id, garage, state)

ParametryCopy Anchor Link

ZwracaCopy Anchor Link

Nic. Nie zapisuje najpierw stanu: wywołaj przed nim SaveVehicle, gdy uszkodzenia i paliwo mają zostać zachowane. Aby zaparkować przez dowolny skrypt garaży, którego używa serwer, użyj zamiast tego garages.store z biblioteki.

SetOwnerCopy Anchor Link

Daje pojazd innemu właścicielowi (sprzedaż między graczami, auto przeniesione do floty pracy).

Strona: serwer · Czeka: nie

SetOwner(id: number, owner: VehicleOwner): void

exports['ai-vehicles']:SetOwner(id, owner)

ZwracaCopy Anchor Link

Nic. Nieprawidłowy właściciel lub nieznane ID nic nie robią. Klucze starego właściciela nie są zabierane: w razie potrzeby usuń je przez vehicleKeys.remove z biblioteki.

PrzykładCopy Anchor Link

vehicles.SetOwner(vehicleId, { type: "job", id: "mechanic" });

DeleteVehicleCopy Anchor Link

Usuwa posiadany pojazd na zawsze: jego encję, jeśli jest na zewnątrz, i jego wiersz w bazie danych.

Strona: serwer · Czeka: nie

DeleteVehicle(id: number): void

exports['ai-vehicles']:DeleteVehicle(id)

ZwracaCopy Anchor Link

Nic.

SpawnVehicleCopy Anchor Link

Tworzy w świecie encję posiadanego pojazdu z jego wyglądem, tablicą, paliwem i state bagami oraz daje klucze graczowi asker przez aktywny system kluczy. Stan pojazdu zmienia się na out.

Strona: serwer · Czeka: nie (wynik przychodzi w cb)

SpawnVehicle(id: number, at: { x: number; y: number; z: number; heading: number }, asker: number, cb: (netId: number | null) => void, purpose?: KeyPurpose, setup?: VehicleSetup): void

exports['ai-vehicles']:SpawnVehicle(id, at, asker, function(netId) end, purpose, setup)

ParametryCopy Anchor Link

ZwracaCopy Anchor Link

Nic. cb dostaje ID sieciowe albo null, gdy pojazd nie istnieje, jest już na zewnątrz, jest właśnie tworzony albo gra nie mogła go utworzyć.

PrzykładCopy Anchor Link

import { resourceExport } from "@aicore-fivem/lib/server";

const vehicles = resourceExport("ai-vehicles");

export function bringOut(source: number, vehicleId: number): void {
  const ped = GetPlayerPed(String(source));
  const [x, y, z] = GetEntityCoords(ped);
  const heading = GetEntityHeading(ped);
  vehicles.SpawnVehicle(vehicleId, { x: x + 3, y, z, heading }, source, (netId) => {
    if (netId === null) console.log(`vehicle ${vehicleId} could not come out`);
  });
}

ZdarzeniaCopy Anchor Link

ai-vehicles:ownersCopy Anchor Link

Wywoływane, gdy pojazdy trafiają do pamięci ai-vehicles lub zmieniają właściciela oraz gdy tablice opuszczają pamięć. Jedna paczka na tick serwera. Odczytaj GetPlateOwners raz przy starcie, a potem nakładaj te paczki, aby utrzymywać kopię przypisań tablica-właściciel. Nazwa to VEHICLES_EVENTS.owners w @aicore-fivem/shared.

Strona: serwer (zdarzenie lokalne, niewysyłane do klientów)

import { resourceExport } from "@aicore-fivem/lib/server";
import { VEHICLES_EVENTS } from "@aicore-fivem/shared";

const owners = new Map<string, string>();
for (const [plate, type, id] of resourceExport("ai-vehicles").GetPlateOwners())
  owners.set(plate, `${type}:${id}`);

on(VEHICLES_EVENTS.owners, (puts: [string, string, string][], removes: string[]) => {
  for (const [plate, type, id] of puts) owners.set(plate, `${type}:${id}`);
  for (const plate of removes) owners.delete(plate);
});

State bagiCopy Anchor Link

ai-vehicles ustawia je na każdym posiadanym pojeździe, który tworzy w świecie. Nazwy są w VEHICLE_BAGS (@aicore-fivem/shared).

local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
if Entity(vehicle).state['ai:owned'] then
  print('owned vehicle', Entity(vehicle).state['ai:vid'])
end

API qbx_vehiclesCopy Anchor Link

ai-vehicles robi provide dla qbx_vehicles, więc te wywołania do niego trafiają. Kształty są zgodne z Qbox: state to 0 na zewnątrz, 1 garaż, 2 parking policyjny.

GetPlayerVehicle zwraca props w kształcie VehicleProps z AI Core, a nie ox_lib. depotPrice zawsze wynosi 0.