DestinyObjectiveProgress class
Returns data about a character's status with a given Objective. Combine with DestinyObjectiveDefinition static data for display purposes.
- Annotations
-
- @JsonSerializable()
Constructors
- DestinyObjectiveProgress()
-
DestinyObjectiveProgress.fromJson(Map<
String, dynamic> json) -
factory
Properties
- activityHash ↔ int?
-
If the Objective has an Activity associated with it, this is the unique identifier of the Activity being referred to. Use to look up the DestinyActivityDefinition in static data. This will give localized data about what you should be playing for the objective to be achieved.
getter/setter pair
- complete ↔ bool?
-
Whether or not the Objective is completed.
getter/setter pair
- completionValue ↔ int?
-
As of Forsaken, objectives' completion value is determined dynamically at runtime.
This value represents the threshold of progress you need to surpass in order for this objective to be considered "complete".
If you were using objective data, switch from using the DestinyObjectiveDefinition's "completionValue" to this value.
getter/setter pair
- destinationHash ↔ int?
-
If the Objective has a Destination associated with it, this is the unique identifier of the Destination being referred to. Use to look up the DestinyDestinationDefinition in static data. This will give localized data about where in the universe the objective should be achieved.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- objectiveHash ↔ int?
-
The unique identifier of the Objective being referred to. Use to look up the DestinyObjectiveDefinition in static data.
getter/setter pair
- progress ↔ int?
-
If progress has been made, and the progress can be measured numerically, this will be the value of that progress. You can compare it to the DestinyObjectiveDefinition.completionValue property for current vs. upper bounds, and use DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle to determine how this should be rendered. Note that progress, in Destiny 2, need not be a literal numeric progression. It could be one of a number of possible values, even a Timestamp. Always examine DestinyObjectiveDefinition.inProgressValueStyle or completedValueStyle before rendering progress.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- visible ↔ bool?
-
If this is true, the objective is visible in-game. Otherwise, it's not yet visible to the player. Up to you if you want to honor this property.
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<DestinyObjectiveProgress>