DestinyItemPlugComponent class
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.
- Annotations
-
- @JsonSerializable()
Constructors
- DestinyItemPlugComponent()
-
DestinyItemPlugComponent.fromJson(Map<
String, dynamic> json) -
factory
Properties
- canInsert ↔ bool?
-
If true, this plug has met all of its insertion requirements. Big if true.
getter/setter pair
- enabled ↔ bool?
-
If true, this plug will provide its benefits while inserted.
getter/setter pair
-
enableFailIndexes
↔ List<
int> ? -
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.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
-
insertFailIndexes
↔ List<
int> ? -
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.
getter/setter pair
- plugItemHash ↔ int?
-
The hash identifier of the DestinyInventoryItemDefinition that represents this plug.
getter/setter pair
-
plugObjectives
↔ List<
DestinyObjectiveProgress> ? -
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.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
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<DestinyItemPlugComponent>