Items

To API pozwala na pobieranie danych z rejestru przedmiotów.

GetFromRegister

Pobierz przedmiot z rejestru

Funkcja jest asynchroniczna, lecz konstrukcja komunikacji do lua opczekuje na zwrot danych z javascript.
Syntax
-- One item
--- itemName: string
local itemData = Inventory.Items.GetFromRegister(itemName)
--- itemData: RegisterItem | undefined

-- Multiple items at once
--- itemNames: string[]
local itemsData = Inventory.Items.GetFromRegister(itemNames)
--- itemsData: (RegisterItem | undefined)[]
Types
export type RegisterItem = RegisterItemConstructor & {
  name: string;
  label: string;
  weight: number; // weight of singular item
  imageUrl: string;
  description: string | ((source: number, item: Item) => string);
  damageable?: boolean;
  categories?: string[];
  registerFingerprints?: boolean;
  stackable?: boolean;
  maxStack?: number;
  extraActions?: (source: number, item: API.ItemClass) => ItemExtraAction[];
  isSSRDescription?: boolean;
  usable?: boolean;
};
Examples
local itemData = Inventory.Items.GetFromRegister('bread')

local itemsData = Inventory.Items.GetFromRegister({'bread', 'water'})
local breadData = itemsData[1]
local waterData = itemsData[2]