bungie-net-core/models/Destiny/Components/Items/DestinyItemPlugComponent.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.
 */
import { DestinyObjectiveProgress } from '../../Quests/DestinyObjectiveProgress';
/**
 * Plugs are non-instanced items that can provide Stat and Perk benefits when
 * socketed into an instanced item. Items have Sockets, and Plugs are inserted into
 * Sockets.
 *
 * This component finds all items that are considered "Plugs" in your inventory,
 * and return information about the plug aside from any specific Socket into which
 * it could be inserted.
 * @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Components.Items.DestinyItemPlugComponent}
 */
export interface DestinyItemPlugComponent {
    /**
     * Sometimes, Plugs may have objectives: these are often used for flavor and
     * display purposes, but they can be used for any arbitrary purpose (both
     * fortunately and unfortunately). Recently (with Season 2) they were expanded in
     * use to be used as the "gating" for whether the plug can be inserted at all. For
     * instance, a Plug might be tracking the number of PVP kills you have made. It
     * will use the parent item's data about that tracking status to determine what to
     * show, and will generally show it using the DestinyObjectiveDefinition's
     * progressDescription property. Refer to the plug's itemHash and objective
     * property for more information if you would like to display even more data.
     */
    readonly plugObjectives: DestinyObjectiveProgress[];
    /**
     * The hash identifier of the DestinyInventoryItemDefinition that represents this
     * plug. Mapped to DestinyInventoryItemDefinition in the manifest.
     */
    readonly plugItemHash: number;
    /** If true, this plug has met all of its insertion requirements. Big if true. */
    readonly canInsert: boolean;
    /** If true, this plug will provide its benefits while inserted. */
    readonly enabled: boolean;
    /**
     * If the plug cannot be inserted for some reason, this will have the indexes into
     * the plug item definition's plug.insertionRules property, so you can show the
     * reasons why it can't be inserted.
     *
     * This list will be empty if the plug can be inserted.
     */
    readonly insertFailIndexes: number[];
    /**
     * If a plug is not enabled, this will be populated with indexes into the plug item
     * definition's plug.enabledRules property, so that you can show the reasons why it
     * is not enabled.
     *
     * This list will be empty if the plug is enabled.
     */
    readonly enableFailIndexes: number[];
    /** If available, this is the stack size to display for the socket plug item. */
    readonly stackSize?: number;
    /** If available, this is the maximum stack size to display for the socket plug item. */
    readonly maxStackSize?: number;
}