This page was generated with Wiki Builder. Do not change the format!
Info
Information about the item's calculated stats, with as much data as we can find for the stats without having an actual instance of the item. Note that this means the entire concept of providing these stats is fundamentally insufficient: we cannot predict with 100% accuracy the conditions under which an item can spawn, so we use various heuristics to attempt to simulate the conditions as accurately as possible. Actual stats for items in-game can and will vary, but these should at least be useful base points for comparison and display. It is also worth noting that some stats, like Magazine size, have further calculations performed on them by scripts in-game and on the game servers that BNet does not have access to. We cannot know how those stats are further transformed, and thus some stats will be inaccurate even on instances of items in BNet vs. how they appear in-game. This is a known limitation of our item statistics, without any planned fix.
Schema
- Schema Type: Definition
- Type: object
Properties
| Name | Type | Description |
|---|---|---|
| statGroupHash | Destiny.Definitions.DestinyStatGroupDefinition:integer:uint32:nullable | If the item's stats are meant to be modified by a DestinyStatGroupDefinition, this will be the identifier for that definition. If you are using live data or precomputed stats data on the DestinyInventoryItemDefinition.stats.stats property, you don't have to worry about statGroupHash and how it alters stats: the already altered stats are provided to you. But if you want to see how the sausage gets made, or perform computations yourself, this is valuable information. |
| stats | Dictionary<Destiny.Definitions.DestinyStatDefinition:integer:uint32,DestinyInventoryItemStatDefinition:Definition> | If you are looking for precomputed values for the stats on a weapon, this is where they are stored. Technically these are the "Display" stat values. Please see DestinyStatsDefinition for what Display Stat Values means, it's a very long story... but essentially these are the closest values BNet can get to the item stats that you see in-game. These stats are keyed by the DestinyStatDefinition's hash identifier for the stat that's found on the item. |
| hasDisplayableStats | boolean | A quick and lazy way to determine whether any stat other than the "primary" stat is actually visible on the item. Items often have stats that we return in case people find them useful, but they're not part of the "Stat Group" and thus we wouldn't display them in our UI. If this is False, then we're not going to display any of these stats other than the primary one. |
| primaryBaseStatHash | Destiny.Definitions.DestinyStatDefinition:integer:uint32 | This stat is determined to be the "primary" stat, and can be looked up in the stats or any other stat collection related to the item. Use this hash to look up the stat's value using DestinyInventoryItemDefinition.stats.stats, and the renderable data for the primary stat in the related DestinyStatDefinition. |
Example
{
// Type: Destiny.Definitions.DestinyStatGroupDefinition:integer:uint32:nullable
"statGroupHash": 0,
// Type: Dictionary<Destiny.Definitions.DestinyStatDefinition:integer:uint32,DestinyInventoryItemStatDefinition:Definition>
"stats": {
"0": {
// Type: Destiny.Definitions.DestinyStatDefinition:integer:uint32
"statHash": 0,
// Type: integer:int32
"value": 0,
// Type: integer:int32
"minimum": 0,
// Type: integer:int32
"maximum": 0
}
},
// Type: boolean
"hasDisplayableStats": false,
// Type: Destiny.Definitions.DestinyStatDefinition:integer:uint32
"primaryBaseStatHash": 0
}