ai-inventory dla deweloperów

Odwołania do ekwipunkuCopy Anchor Link

Każdy eksport serwera, który przyjmuje inv, akceptuje:

Eksporty serweraCopy Anchor Link

Typowane jako AiInventoryServerExports w @aicore-fivem/shared: resourceExport("ai-inventory") w TypeScript.

AddItemCopy Anchor Link

Dodaje przedmioty do ekwipunku. Stosy o tej samej nazwie i metadanych łączą się do rozmiaru stosu przedmiotu; reszta trafia do wolnych komórek.

Strona: serwer · Czeka: nie

AddItem(inv: number | string, item: string, count: number, metadata?: Record<string, unknown>, slot?: number): boolean

local ok = exports['ai-inventory']:AddItem(source, 'water', 2)

ParametryCopy Anchor Link

ZwracaCopy Anchor Link

boolean: true, gdy dodano wszystkie sztuki. false, gdy ekwipunek lub przedmiot jest nieznany, count jest nieprawidłowy albo przedmiot się nie mieści (komórki lub waga). Gdy odpowiada false, nic nie jest dodawane.

PrzykładCopy Anchor Link

import { resourceExport, onClientCallback } from "@aicore-fivem/lib/server";
import { fail } from "@aicore-fivem/lib/shared";

const inv = resourceExport("ai-inventory");

onClientCallback("myscript:buyWater", (source) => {
  if (!inv.CanCarryItem(source, "water", 1)) return fail("NO_SPACE");
  if (!inv.AddItem(source, "water", 1)) return fail("NO_SPACE");
  return { ok: true };
});

RemoveItemCopy Anchor Link

Zabiera przedmioty z ekwipunku.

Strona: serwer · Czeka: nie

RemoveItem(inv: number | string, item: string, count: number, metadata?: Record<string, unknown>, slot?: number): boolean

ZwracaCopy Anchor Link

boolean: true, gdy zabrano wszystkie sztuki. false, gdy jest ich za mało (wtedy nic nie jest zabierane). Broń zabrana graczowi jest też zabierana z jego rąk.

GetItemCountCopy Anchor Link

GetItemCount(inv: number | string, item: string, metadata?: Record<string, unknown>): number

Ile sztuk item (pasujących do metadata, jeśli podano) zawiera ekwipunek. 0 dla nieznanego ekwipunku lub przedmiotu. Strona: serwer · Czeka: nie.

CanCarryItemCopy Anchor Link

CanCarryItem(inv: number | string, item: string, count: number, metadata?: Record<string, unknown>): boolean

Czy count sztuk by się zmieściło (komórki i waga), bez ich dodawania. Strona: serwer · Czeka: nie.

GetItemsCopy Anchor Link

GetItems(inv: number | string): Array<{ name, label, weight, slot, count, amount, metadata, info, stack, unique, close, description, type, image }>

Każdy stos ekwipunku. count / metadata (nazwy ox) i amount / info (nazwy qb) mają te same wartości; weight to łączna waga stosu w gramach. Pusta lista dla nieznanego ekwipunku. Strona: serwer · Czeka: nie.

GetWeightCopy Anchor Link

GetWeight(inv: number | string): { weight: number; maxWeight: number } | null

Niesiona waga i limit w gramach (maxWeight 0 = bez limitu). null, gdy ekwipunek nie jest wczytany. Strona: serwer · Czeka: nie.

RegisterUsableItemCopy Anchor Link

Uruchamia twoją funkcję, gdy gracz używa przedmiotu. Najpierw odtwarzana jest animacja przedmiotu (jeśli jest); twoja funkcja uruchamia się po jej zakończeniu.

Strona: serwer · Czeka: nie

RegisterUsableItem(name: string, handler: (source: number, item: { name: string; slot: number; count: number; metadata: Record<string, unknown> }) => unknown): void

PrzykładCopy Anchor Link

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

const inv = resourceExport("ai-inventory");

inv.RegisterUsableItem("repairkit", (source, item) => {
  const ped = GetPlayerPed(String(source));
  const vehicle = GetVehiclePedIsIn(ped, false);
  if (vehicle === 0) {
    notify(source, "Sit in a vehicle first", "error");
    return false; // zachowaj przedmiot
  }
  emitNet("myscript:repair", source, NetworkGetNetworkIdFromEntity(vehicle));
});

RegisterStashCopy Anchor Link

Rejestruje schowek ze skryptu (dom, szafka gangu). Wspólne schowki są wczytywane od razu i pozostają wczytane.

Strona: serwer · Czeka: nie

RegisterStash(name: string, label: string, slots: number, maxWeight: number, jobs?: string[], personal?: boolean): void

Schowek skryptu nie ma miejsca w świecie: otwieraj go przez OpenInventory.

OpenInventoryCopy Anchor Link

Otwiera ekwipunek na ekranie gracza, obok jego własnego.

Strona: serwer · Czeka: nie

OpenInventory(source: number, inv: number | string): boolean

ZwracaCopy Anchor Link

boolean: true, gdy otwarto. false, gdy gracz nie ma wczytanego ekwipunku, ekwipunek jest nieznany lub niewczytany albo jest to własny ekwipunek gracza.

PrzykładCopy Anchor Link

import { resourceExport, onClientCallback } from "@aicore-fivem/lib/server";
import { fail } from "@aicore-fivem/lib/shared";

const inv = resourceExport("ai-inventory");
inv.RegisterStash("gang_ballas", "Ballas locker", 60, 200_000);

onClientCallback("myscript:openLocker", (source) => {
  return inv.OpenInventory(source, "gang_ballas") ? { ok: true } : fail("CANNOT_OPEN");
});

ClearInventoryCopy Anchor Link

ClearInventory(inv: number | string): void

Opróżnia ekwipunek. Strona: serwer · Czeka: nie.

RegisterShop and OpenShopCopy Anchor Link

Sklep bez miejsca, otwierany przez twój skrypt (aplikacja telefonu, menu NPC). Kupowanie jest możliwe tylko wtedy, gdy gracz ma go otwartego, płatne z gotówki, potem z banku. Sklep z panelu o tym samym ID ma pierwszeństwo.

Strona: serwer · Czeka: nie

RegisterShop(name: string, label: string, items: Array<{ name: string; price: number }>): void
OpenShop(source: number, name: string): boolean

OpenShop zwraca false, gdy sklep jest nieznany lub gracz nie ma ekwipunku.

PrzedmiotyCopy Anchor Link

Items(name?: string): { name, label, weight, stack, unique, close, description, type, image, useable } | Record<string, ...> | null

Jedna definicja przedmiotu (kształt ox), wszystkie definicje według nazwy, gdy name jest pominięte, albo null dla nieznanej nazwy. stack jest true, gdy rozmiar stosu jest większy niż 1; unique, gdy wynosi 1. Strona: serwer · Czeka: nie.

Eksporty klientaCopy Anchor Link

OpenSelf i HasItem są typowane jako AiInventoryClientExports.

ZdarzeniaCopy Anchor Link

ai-inventory:usedItemCopy Anchor Link

Wywoływane na serwerze po każdym użyciu przedmiotu.

Strona: serwer (zdarzenie lokalne)

on("ai-inventory:usedItem", (source: number, name: string) => {
  if (name === "joint") emitNet("myscript:highEffect", source);
});

AI Core zamienia to na własne zdarzenie ai-core:itemUsed (source, name, status), którego należy nasłuchiwać, jeśli twój skrypt ma działać z każdym ekwipunkiem.

API ox_inventoryCopy Anchor Link

ai-inventory robi provide dla ox_inventory i odpowiada na jego eksporty (pisane pod ox_inventory 2.44). Ekwipunki są nazywane jak w ox: source gracza, nazwa schowka, { id, owner } dla schowków osobistych, tablica dla bagażników.

• Serwer: AddItem (zwraca success, response, wywołuje cb), RemoveItem, GetItem, GetItemCount, Search (count / slots), CanCarryItem, CanCarryWeight, CanCarryAmount, GetInventory, GetInventoryItems, GetSlot, GetSlotWithItem, GetSlotsWithItem, GetSlotIdWithItem, GetSlotIdsWithItem, GetEmptySlot, SetMetadata, SetDurability, SetMaxWeight, RegisterStash, ClearInventory, Items, ItemList, forceOpenInventory (schowek, gracz, sklep), CreateTemporaryStash, CustomDrop, RemoveInventory, SwapSlots.
• Klient: openInventory, closeInventory, Search, GetItemCount, GetPlayerItems, GetPlayerWeight, GetPlayerMaxWeight, Items, useSlot, getCurrentWeapon / GetCurrentWeapon. displayMetadata, weaponWheel i setStashTarget są akceptowane i nic nie robią.
• Bez odpowiedzi: hooki (registerHook, removeHooks), UpdateVehicle, ConfiscateInventory / ReturnInventory, GetContainerFromSlot, RegisterShop (sklepy pochodzą z panelu lub z własnego RegisterShop ai-inventory).

API qb-inventoryCopy Anchor Link

ai-inventory robi provide dla qb-inventory (API 2.0). Zwracane przedmioty mają oba kształty: count / metadata i amount / info.

• Serwer: AddItem(identifier, item, amount, slot, info), RemoveItem, HasItem (nazwa, lista lub { name = amount }), GetItemCount, GetItemByName, GetItemsByName, GetItemBySlot, CanAddItem, GetFreeWeight, GetSlots, ClearInventory, SetItemData, CreateInventory, OpenInventory, OpenInventoryById, RemoveInventory, CloseInventory.
• Klient: HasItem, CloseInventory.
• Bez odpowiedzi: hooki i listenery, CreateShop / OpenShop, SetInventory, GetInventory, SaveInventory, LoadInventory, UseItem, GetFirstSlotByItem, GetSlotsByItem, GetTotalWeight.

Baza danych i logiCopy Anchor Link

Tabela ai_inventory_inventories: jeden wiersz na zapisany ekwipunek (id, JSON items). Zapisuje ją tylko ai-inventory; zmiany są zapisywane co 30 sekund, przy zwalnianiu i przy zatrzymaniu. Kanały logów: moves (domyślnie wyłączony), drops, gives, purchases, crafting.