DestinyItemSocketState class
The status of a given item's socket. (which plug is inserted, if any: whether it is enabled, what "reusable" plugs can be inserted, etc...)
If I had it to do over, this would probably have a DestinyItemPlug representing the inserted item instead of most of these properties. :shrug:
Constructors
Properties
-
enableFailIndexes
↔ List<
int> -
If a plug is inserted but 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.
read / write
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- isEnabled ↔ bool
-
Even if a plug is inserted, it doesn't mean it's enabled. [...]
read / write
- isVisible ↔ bool
-
A plug may theoretically provide benefits but not be visible - for instance,
some older items use a plug's damage type perk to modify their own damage type.
These, though they are not visible, still affect the item. This field indicates
that state. [...]
read / write
- plugHash ↔ int
-
The currently active plug, if any. [...]
read / write
-
plugObjectives
↔ List<
DestinyObjectiveProgress> -
Sometimes, Plugs may have objectives: generally, these are used for flavor and
display purposes. 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.
read / write
-
reusablePlugHashes
↔ List<
int> -
If the item supports reusable plugs, this is the list of plug item hashes that
are currently allowed to be used for this socket. See the "reusablePlugs"
property, which has rendered this obsolete, for more information. [...]
read / write
-
reusablePlugs
↔ List<
DestinyItemPlug> -
If the item supports reusable plugs, this is the list of plugs that are allowed
to be used for the socket, and any relevant information about whether they are "
enabled", whether they are allowed to be inserted, and any other information
such as objectives. [...]
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited