Source

This page was generated with Wiki Builder. Do not change the format!

Info

This component returns anything that could be considered "Progression" on a user: data where the user is gaining levels, reputation, completions, rewards, etc...

Schema

  • Schema Type: Class
  • Type: object
  • Component Type Dependency: CharacterProgressions

Properties

Name Type Description
progressions Dictionary<Destiny.Definitions.DestinyProgressionDefinition:integer:uint32,DestinyProgression> A Dictionary of all known progressions for the Character, keyed by the Progression's hash. Not all progressions have user-facing data, but those who do will have that data contained in the DestinyProgressionDefinition.
factions Dictionary<Destiny.Definitions.DestinyFactionDefinition:integer:uint32,DestinyFactionProgression> A dictionary of all known Factions, keyed by the Faction's hash. It contains data about this character's status with the faction.
milestones Dictionary<Destiny.Definitions.Milestones.DestinyMilestoneDefinition:integer:uint32,DestinyMilestone> Milestones are related to the simple progressions shown in the game, but return additional and hopefully helpful information for users about the specifics of the Milestone's status.
quests DestinyQuestStatus[] If the user has any active quests, the quests' statuses will be returned here. Note that quests have been largely supplanted by Milestones, but that doesn't mean that they won't make a comeback independent of milestones at some point.
uninstancedItemObjectives Dictionary<Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32,DestinyObjectiveProgress[]> Sometimes, you have items in your inventory that don't have instances, but still have Objective information. This provides you that objective information for uninstanced items. This dictionary is keyed by the item's hash: which you can use to look up the name and description for the overall task(s) implied by the objective. The value is the list of objectives for this item, and their statuses.

Example

{
    // Type: Dictionary<Destiny.Definitions.DestinyProgressionDefinition:integer:uint32,DestinyProgression>
    "progressions": {
        "0": {
            // Type: Destiny.Definitions.DestinyProgressionDefinition:integer:uint32
            "progressionHash": 0,
            // Type: integer:int32
            "dailyProgress": 0,
            // Type: integer:int32
            "dailyLimit": 0,
            // Type: integer:int32
            "weeklyProgress": 0,
            // Type: integer:int32
            "weeklyLimit": 0,
            // Type: integer:int32
            "currentProgress": 0,
            // Type: integer:int32
            "level": 0,
            // Type: integer:int32
            "levelCap": 0,
            // Type: integer:int32
            "stepIndex": 0,
            // Type: integer:int32
            "progressToNextLevel": 0,
            // Type: integer:int32
            "nextLevelAt": 0
        }
    },
    // Type: Dictionary<Destiny.Definitions.DestinyFactionDefinition:integer:uint32,DestinyFactionProgression>
    "factions": {
        "0": {
            // Type: Destiny.Definitions.DestinyFactionDefinition:integer:uint32
            "factionHash": 0,
            // Type: integer:int32
            "factionVendorIndex": 0,
            // Type: Destiny.Definitions.DestinyProgressionDefinition:integer:uint32
            "progressionHash": 0,
            // Type: integer:int32
            "dailyProgress": 0,
            // Type: integer:int32
            "dailyLimit": 0,
            // Type: integer:int32
            "weeklyProgress": 0,
            // Type: integer:int32
            "weeklyLimit": 0,
            // Type: integer:int32
            "currentProgress": 0,
            // Type: integer:int32
            "level": 0,
            // Type: integer:int32
            "levelCap": 0,
            // Type: integer:int32
            "stepIndex": 0,
            // Type: integer:int32
            "progressToNextLevel": 0,
            // Type: integer:int32
            "nextLevelAt": 0
        }
    },
    // Type: Dictionary<Destiny.Definitions.Milestones.DestinyMilestoneDefinition:integer:uint32,DestinyMilestone>
    "milestones": {
        "0": {
            // Type: Destiny.Definitions.Milestones.DestinyMilestoneDefinition:integer:uint32
            "milestoneHash": 0,
            // Type: DestinyMilestoneQuest[]
            "availableQuests": [
               // Type: DestinyMilestoneQuest
                {
                    // Type: Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32
                    "questItemHash": 0,
                    // Type: DestinyQuestStatus
                    "status": {},
                    // Type: DestinyMilestoneActivity
                    "activity": {},
                    // Type: DestinyChallengeStatus[]
                    "challenges": [
                       // Type: DestinyChallengeStatus
                        {
                            // Type: DestinyObjectiveProgress
                            "objective": {}
                        }
                    ]
                }
            ],
            // Type: Dictionary<string,number:float>
            "values": {
                "{string}": 0
            },
            // Type: Destiny.Definitions.DestinyVendorDefinition:integer:uint32[]
            "vendorHashes": [
               // Type: integer:uint32
                0
            ],
            // Type: DestinyMilestoneVendor[]
            "vendors": [
               // Type: DestinyMilestoneVendor
                {
                    // Type: Destiny.Definitions.DestinyVendorDefinition:integer:uint32
                    "vendorHash": 0,
                    // Type: Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32:nullable
                    "previewItemHash": 0
                }
            ],
            // Type: DestinyMilestoneRewardCategory[]
            "rewards": [
               // Type: DestinyMilestoneRewardCategory
                {
                    // Type: integer:uint32
                    "rewardCategoryHash": 0,
                    // Type: DestinyMilestoneRewardEntry[]
                    "entries": [
                       // Type: DestinyMilestoneRewardEntry
                        {
                            // Type: integer:uint32
                            "rewardEntryHash": 0,
                            // Type: boolean
                            "earned": false,
                            // Type: boolean
                            "redeemed": false
                        }
                    ]
                }
            ],
            // Type: string:date-time:nullable
            "startDate": "",
            // Type: string:date-time:nullable
            "endDate": ""
        }
    },
    // Type: DestinyQuestStatus[]
    "quests": [
       // Type: DestinyQuestStatus
        {
            // Type: Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32
            "questHash": 0,
            // Type: Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32
            "stepHash": 0,
            // Type: DestinyObjectiveProgress[]
            "stepObjectives": [
               // Type: DestinyObjectiveProgress
                {
                    // Type: Destiny.Definitions.DestinyObjectiveDefinition:integer:uint32
                    "objectiveHash": 0,
                    // Type: Destiny.Definitions.DestinyDestinationDefinition:integer:uint32:nullable
                    "destinationHash": 0,
                    // Type: Destiny.Definitions.DestinyActivityDefinition:integer:uint32:nullable
                    "activityHash": 0,
                    // Type: integer:int32:nullable
                    "progress": 0,
                    // Type: boolean
                    "complete": false
                }
            ],
            // Type: boolean
            "tracked": false,
            // Type: integer:int64
            "itemInstanceId": 0,
            // Type: boolean
            "completed": false,
            // Type: boolean
            "redeemed": false,
            // Type: boolean
            "started": false,
            // Type: integer:uint32:nullable
            "vendorHash": 0
        }
    ],
    // Type: Dictionary<Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32,DestinyObjectiveProgress[]>
    "uninstancedItemObjectives": {
        "0": [
           // Type: DestinyObjectiveProgress
            {
                // Type: Destiny.Definitions.DestinyObjectiveDefinition:integer:uint32
                "objectiveHash": 0,
                // Type: Destiny.Definitions.DestinyDestinationDefinition:integer:uint32:nullable
                "destinationHash": 0,
                // Type: Destiny.Definitions.DestinyActivityDefinition:integer:uint32:nullable
                "activityHash": 0,
                // Type: integer:int32:nullable
                "progress": 0,
                // Type: boolean
                "complete": false
            }
        ]
    }
}

References

  1. https://bungie-net.github.io/multi/schema_Destiny-Entities-Characters-DestinyCharacterProgressionComponent.html#schema_Destiny-Entities-Characters-DestinyCharacterProgressionComponent