X2GuildBank

Globals

X2GuildBank

X2GuildBank

Classes

Class: X2GuildBank

Method: CountItems

(method) X2GuildBank:CountItems()
  -> itemCount: number

Returns the total number of items in the player’s guild bank.

@return itemCount — The total count of items currently in the guild bank.

Method: GetBagItemInfo

(method) X2GuildBank:GetBagItemInfo(slot: number, neededInfo?: `IIK_CATEGORY`|`IIK_CONSUME_ITEM`|`IIK_GRADE_STR`|`IIK_GRADE`|`IIK_IMPL`...(+5))
  -> guild: ItemInfo|nil

Retrieves item information for the specified slot if it exists. The player must interact with a guild bank for this to return anything.

@param slot — The slot to query. (min: 1)

@param neededInfo — Optional additional information for the item.

@return guild — bankItemInfo The item information, or nil if the slot is empty or doesn’t exist.

-- api/X2Item
-- Values can be added together to get more information.
neededInfo:
    | `IIK_CATEGORY`
    | `IIK_CONSUME_ITEM`
    | `IIK_GRADE`
    | `IIK_GRADE_STR`
    | `IIK_IMPL`
    | `IIK_NAME`
    | `IIK_SELL`
    | `IIK_SOCKET_MODIFIER`
    | `IIK_STACK`
    | `IIK_TYPE`

See: ItemInfo

Method: ItemStack

(method) X2GuildBank:ItemStack(slot: number)
  -> itemStack: number

Returns the current stack size of the item in the specified guild bank slot.

@param slot — The guild bank slot index. (min: 1)

@return itemStack — The number of items in the stack.