bungie-net-core/models/Destiny/DestinyItemQuantity.d.ts

An easy way to interact with the Bungie.net API

/**
 * Bungie.Net API
 * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
 *
 * Contact: support@bungie.com
 *
 * NOTE: This class is auto generated by the bungie-net-core code generator program
 * Repository: {@link https://github.com/owens1127/bungie-net-core}
 * Do not edit these files manually.
 */
/**
 * Used in a number of Destiny contracts to return data about an item stack and its
 * quantity. Can optionally return an itemInstanceId if the item is instanced - in
 * which case, the quantity returned will be 1. If it's not... uh, let me know okay?
 * Thanks.
 * @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.DestinyItemQuantity}
 */
export interface DestinyItemQuantity {
    /**
     * The hash identifier for the item in question. Use it to look up the item's
     * DestinyInventoryItemDefinition. Mapped to DestinyInventoryItemDefinition in the
     * manifest.
     */
    readonly itemHash: number;
    /**
     * If this quantity is referring to a specific instance of an item, this will have
     * the item's instance ID. Normally, this will be null.
     */
    readonly itemInstanceId?: string;
    /**
     * The amount of the item needed/available depending on the context of where
     * DestinyItemQuantity is being used.
     */
    readonly quantity: number;
    /**
     * Indicates that this item quantity may be conditionally shown or hidden, based on
     * various sources of state. For example: server flags, account state, or character
     * progress.
     */
    readonly hasConditionalVisibility: boolean;
}