DestinyItemComponent class
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.
- Annotations
-
- @JsonSerializable()
Constructors
- DestinyItemComponent()
-
DestinyItemComponent.fromJson(Map<
String, dynamic> json) -
factory
Properties
- bindStatus ↔ ItemBindStatus?
-
If the item is bound to a location, it will be specified in this enum.
getter/setter pair
- bucketHash ↔ int?
-
The hash identifier for the specific inventory bucket in which the item is located.
getter/setter pair
- expirationDate ↔ String?
-
If the item can expire, this is the date at which it will/did expire.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- isWrapper ↔ bool?
-
If this is true, the object is actually a "wrapper" of the object it's representing. This means that it's not the actual item itself, but rather an item that must be "opened" in game before you have and can use the item.
Wrappers are an evolution of "bundles", which give an easy way to let you preview the contents of what you purchased while still letting you get a refund before you "open" it.
getter/setter pair
- itemHash ↔ int?
-
The identifier for the item's definition, which is where most of the useful static information for the item can be found.
getter/setter pair
- 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.
getter/setter pair
-
itemValueVisibility
↔ List<
bool> ? -
If available, a list that describes which item values (rewards) should be shown (true) or hidden (false).
getter/setter pair
- 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.
getter/setter pair
- lockable ↔ bool?
-
If the item can be locked, this will indicate that state.
getter/setter pair
- metricHash ↔ int?
-
The identifier for the currently-selected metric definition, to be displayed on the emblem nameplate.
getter/setter pair
- metricObjective ↔ DestinyObjectiveProgress?
-
The objective progress for the currently-selected metric definition, to be displayed on the emblem nameplate.
getter/setter pair
- overrideStyleItemHash ↔ int?
-
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.
getter/setter pair
- quantity ↔ int?
-
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)
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- 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.
getter/setter pair
-
tooltipNotificationIndexes
↔ List<
int> ? -
If this is populated, it is a list of indexes into DestinyInventoryItemDefinition.tooltipNotifications for any special tooltip messages that need to be shown for this item.
getter/setter pair
- 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).
getter/setter pair
- versionNumber ↔ int?
-
The version of this item, used to index into the versions list in the item definition quality block.
getter/setter pair
Methods
-
asyncToJson(
) → Future< Map< String, dynamic> > -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
asyncFromJson(
Map< String, dynamic> json) → Future<DestinyItemComponent>