DestinyActivityModeDefinition class

This definition represents an "Activity Mode" as it exists in the Historical Stats endpoints. An individual Activity Mode represents a collection of activities that are played in a certain way. For example, Nightfall Strikes are part of a "Nightfall" activity mode, and any activities played as the PVP mode " Clash" are part of the "Clash activity mode.

Activity modes are nested under each other in a hierarchy, so that if you ask for - for example - "AllPvP", you will get any PVP activities that the user has played, regardless of what specific PVP mode was being played.

Constructors

DestinyActivityModeDefinition()

Properties

activityModeCategory int
The type of play being performed in broad terms (PVP, PVE)
read / write
activityModeMappings Map<int, DestinyActivityModeType>
If this exists, the mode has specific Activities (referred to by the Key) that should instead map to other Activity Modes when they are played. This was useful in D1 for Private Matches, where we wanted to have Private Matches as an activity mode while still referring to the specific mode being played.
read / write
display bool
If FALSE, we want to ignore this type when we're showing activity modes in BNet UI. It will still be returned in case 3rd parties want to use it for any purpose.
read / write
displayProperties DestinyDisplayPropertiesDefinition
read / write
friendlyName String
A Friendly identifier you can use for referring to this Activity Mode. We really only used this in our URLs, so... you know, take that for whatever it's worth.
read / write
hash int
The unique identifier for this entity. Guaranteed to be unique for the type of entity, but not globally. [...]
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
index int
The index of the entity as it was found in the investment tables.
read / write
isAggregateMode bool
If true, this mode is an aggregation of other, more specific modes rather than being a mode in itself. This includes modes that group Features/Events rather than Gameplay, such as Trials of The Nine: Trials of the Nine being an Event that is interesting to see aggregate data for, but when you play the activities within Trials of the Nine they are more specific activity modes such as Clash.
read / write
isTeamBased bool
If True, this mode has oppositional teams fighting against each other rather than "Free-For-All" or Co-operative modes of play. [...]
read / write
modeType int
The Enumeration value for this Activity Mode. Pass this identifier into Stats endpoints to get aggregate stats for this mode.
read / write
order int
The relative ordering of activity modes.
read / write
parentHashes List<int>
The hash identifiers of the DestinyActivityModeDefinitions that represent all of the "parent" modes for this mode. For instance, the Nightfall Mode is also a member of AllStrikes and AllPvE.
read / write
pgcrImage String
If this activity mode has a related PGCR image, this will be the path to said image.
read / write
redacted bool
If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry!
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