bungie-net-core
Version:
An easy way to interact with the Bungie.net API
38 lines (37 loc) • 1.47 kB
TypeScript
/**
* A flags enumeration/bitmask where each bit represents a different possible state
* that the item can be in that may effect how the item is displayed to the user
* and what actions can be performed against it.
*
* This enum represents a set of flags - use bitwise operators to check which of
* these match your value.
* @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.ItemState}
*/
export declare const ItemState: {
readonly None: 0;
/**
* If this bit is set, the item has been "locked" by the user and cannot be deleted.
* You may want to represent this visually with a "lock" icon.
*/
readonly Locked: 1;
/**
* If this bit is set, the item is a quest that's being tracked by the user. You
* may want a visual indicator to show that this is a tracked quest.
*/
readonly Tracked: 2;
/**
* If this bit is set, the item has a Masterwork plug inserted. This usually
* coincides with having a special "glowing" effect applied to the item's icon.
*/
readonly Masterwork: 4;
/**
* If this bit is set, the item has been 'crafted' by the player. You may want to
* represent this visually with a "crafted" icon overlay.
*/
readonly Crafted: 8;
/**
* If this bit is set, the item has a 'highlighted' objective. You may want to
* represent this with an orange-red icon border color.
*/
readonly HighlightedObjective: 16;
};