ai-inventory pour les développeurs

Références d’inventaireCopy Anchor Link

Chaque export serveur qui prend inv accepte :

Exports serveurCopy Anchor Link

Typés AiInventoryServerExports dans @aicore-fivem/shared : resourceExport("ai-inventory") en TypeScript.

AddItemCopy Anchor Link

Ajoute des objets à un inventaire. Les piles de même nom et de mêmes métadonnées fusionnent jusqu’à la taille de pile de l’objet ; le reste va dans des cases libres.

Côté : serveur · Attend : non

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

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

ParamètresCopy Anchor Link

RetourCopy Anchor Link

boolean : true quand chaque unité a été ajoutée. false quand l’inventaire ou l’objet est inconnu, que count n’est pas valide, ou que cela ne rentre pas (cases ou poids). Rien n’est ajouté quand il répond false.

ExempleCopy 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

Retire des objets d’un inventaire.

Côté : serveur · Attend : non

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

RetourCopy Anchor Link

boolean : true quand chaque unité a été retirée. false quand il n’y en a pas assez (rien n’est alors retiré). Une arme retirée à un joueur lui est aussi retirée des mains.

GetItemCountCopy Anchor Link

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

Combien d’unités d’item (correspondant à metadata quand elles sont données) contient l’inventaire. 0 pour un inventaire ou un objet inconnu. Côté : serveur · Attend : non.

CanCarryItemCopy Anchor Link

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

Indique si count unités rentreraient (cases et poids), sans les ajouter. Côté : serveur · Attend : non.

GetItemsCopy Anchor Link

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

Chaque pile de l’inventaire. count / metadata (noms ox) et amount / info (noms qb) contiennent les mêmes valeurs ; weight est le total de la pile en grammes. Une liste vide pour un inventaire inconnu. Côté : serveur · Attend : non.

GetWeightCopy Anchor Link

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

Poids porté et limite en grammes (maxWeight 0 = aucune limite). null quand l’inventaire n’est pas chargé. Côté : serveur · Attend : non.

RegisterUsableItemCopy Anchor Link

Exécute votre fonction quand un joueur utilise un objet. L’animation de l’objet (s’il y en a une) se joue d’abord ; votre fonction s’exécute quand elle est terminée.

Côté : serveur · Attend : non

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

ExempleCopy 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; // garder l’objet
  }
  emitNet("myscript:repair", source, NetworkGetNetworkIdFromEntity(vehicle));
});

RegisterStashCopy Anchor Link

Enregistre un stockage depuis un script (une maison, un casier de gang). Les stockages partagés sont chargés immédiatement et restent chargés.

Côté : serveur · Attend : non

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

Un stockage de script n’a pas d’emplacement dans le monde : ouvrez-le avec OpenInventory.

OpenInventoryCopy Anchor Link

Ouvre un inventaire sur l’écran d’un joueur, à côté du sien.

Côté : serveur · Attend : non

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

RetourCopy Anchor Link

boolean : true quand il est ouvert. false quand le joueur n’a pas d’inventaire chargé, que l’inventaire est inconnu ou non chargé, ou que c’est celui du joueur lui-même.

ExempleCopy 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

Vide un inventaire. Côté : serveur · Attend : non.

RegisterShop et OpenShopCopy Anchor Link

Un magasin sans emplacement, ouvert par votre script (une application de téléphone, un menu de PNJ). L’achat n’est autorisé que tant que ce joueur l’a ouvert, payé en liquide puis par la banque. Un magasin du panneau avec le même id l’emporte.

Côté : serveur · Attend : non

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

OpenShop renvoie false quand le magasin est inconnu ou que le joueur n’a pas d’inventaire.

ItemsCopy Anchor Link

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

Une définition d’objet (forme ox), toutes les définitions par nom quand name est omis, ou null pour un nom inconnu. stack vaut true quand la taille de pile est supérieure à 1 ; unique quand elle vaut 1. Côté : serveur · Attend : non.

Exports clientCopy Anchor Link

OpenSelf et HasItem sont typés AiInventoryClientExports.

EventsCopy Anchor Link

ai-inventory:usedItemCopy Anchor Link

Se déclenche sur le serveur après chaque utilisation d’un objet.

Côté : serveur (event local)

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

AI Core transforme cela en son propre event ai-core:itemUsed (source, name, status), celui à écouter si votre script doit fonctionner avec n’importe quel inventaire.

API ox_inventoryCopy Anchor Link

ai-inventory fait un provide d’ox_inventory et répond à ses exports (écrits d’après ox_inventory 2.44). Les inventaires sont désignés comme dans ox : un source de joueur, un nom de stockage, { id, owner } pour les stockages personnels, une plaque pour les coffres.

• Serveur : AddItem (renvoie success, response, appelle 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 (stash, player, shop), CreateTemporaryStash, CustomDrop, RemoveInventory, SwapSlots.
• Client : openInventory, closeInventory, Search, GetItemCount, GetPlayerItems, GetPlayerWeight, GetPlayerMaxWeight, Items, useSlot, getCurrentWeapon / GetCurrentWeapon. displayMetadata, weaponWheel et setStashTarget sont acceptés et ne font rien.
• Non pris en charge : les hooks (registerHook, removeHooks), UpdateVehicle, ConfiscateInventory / ReturnInventory, GetContainerFromSlot, RegisterShop (les magasins viennent du panneau ou du RegisterShop propre à ai-inventory).

API qb-inventoryCopy Anchor Link

ai-inventory fait un provide de qb-inventory (API 2.0). Les objets renvoyés portent les deux formes : count / metadata et amount / info.

• Serveur : AddItem(identifier, item, amount, slot, info), RemoveItem, HasItem (un nom, une liste ou { name = amount }), GetItemCount, GetItemByName, GetItemsByName, GetItemBySlot, CanAddItem, GetFreeWeight, GetSlots, ClearInventory, SetItemData, CreateInventory, OpenInventory, OpenInventoryById, RemoveInventory, CloseInventory.
• Client : HasItem, CloseInventory.
• Non pris en charge : les hooks et les écouteurs, CreateShop / OpenShop, SetInventory, GetInventory, SaveInventory, LoadInventory, UseItem, GetFirstSlotByItem, GetSlotsByItem, GetTotalWeight.

Base de données et logsCopy Anchor Link

Table ai_inventory_inventories : une ligne par inventaire stocké (id, JSON items). Seul ai-inventory l’écrit ; les changements sont enregistrés toutes les 30 secondes, au déchargement et à l’arrêt. Canaux de logs : moves (désactivé par défaut), drops, gives, purchases, crafting.