Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DestinyItemComponent

The base item component, filled with properties that are generally useful to know in any item request or that don't feel worthwhile to put in their own component.

Hierarchy

  • DestinyItemComponent

Index

Properties

bindStatus

bindStatus: ItemBindStatus

If the item is bound to a location, it will be specified in this enum.

bucketHash

bucketHash: number

The hash identifier for the specific inventory bucket in which the item is located.

Mapped to DestinyInventoryBucketDefinition in the manifest.

Optional expirationDate

expirationDate: string

If the item can expire, this is the date at which it will/did expire.

itemHash

itemHash: number

The identifier for the item's definition, which is where most of the useful static information for the item can be found.

Mapped to DestinyInventoryItemDefinition in the manifest.

Optional itemInstanceId

itemInstanceId: string

If the item is instanced, it will have an instance ID. Lack of an instance ID implies that the item has no distinct local qualities aside from stack size.

location

location: ItemLocation

An easy reference for where the item is located. Redundant if you got the item from an Inventory, but useful when making detail calls on specific items.

lockable

lockable: boolean

If the item can be locked, this will indicate that state.

Optional overrideStyleItemHash

overrideStyleItemHash: number

If populated, this is the hash of the item whose icon (and other secondary styles, but not the human readable strings) should override whatever icons/ styles are on the item being sold.

If you don't do this, certain items whose styles are being overridden by socketed items - such as the "Recycle Shader" item - would show whatever their default icon/style is, and it wouldn't be pretty or look accurate.

Mapped to DestinyInventoryItemDefinition in the manifest.

quantity

quantity: number

The quantity of the item in this stack. Note that Instanced items cannot stack. If an instanced item, this value will always be 1 (as the stack has exactly one item in it)

state

state: ItemState

A flags enumeration indicating the transient/custom states of the item that affect how it is rendered: whether it's tracked or locked for example, or whether it has a masterwork plug inserted.

This enum represents a set of flags - use bitwise operators to check which of these match your value.

transferStatus

transferStatus: TransferStatuses

If there is a known error state that would cause this item to not be transferable, this Flags enum will indicate all of those error states. Otherwise, it will be 0 (CanTransfer).

This enum represents a set of flags - use bitwise operators to check which of these match your value.