Source
This page was generated with Wiki Builder. Do not change the format!
Info
So much of what you see in Destiny is actually an Item used in a new and creative way. This is the definition for Items in Destiny, which started off as just entities that could exist in your Inventory but ended up being the backing data for so much more: quests, reward previews, slots, and subclasses. In practice, you will want to associate this data with "live" item data from a Bungie.Net Platform call: these definitions describe the item in generic, non-instanced terms: but an actual instance of an item can vary widely from these generic definitions.
Schema
- Schema Type: Manifest Definition
- Type: object
- Mobile Manifest: Items
Properties
| Name | Type | Description |
|---|---|---|
| displayProperties | DestinyDisplayPropertiesDefinition:Definition | |
| secondaryIcon | string | A secondary icon associated with the item. Currently this is used in very context specific applications, such as Emblem Nameplates. |
| secondaryOverlay | string | Pulled from the secondary icon, this is the "secondary background" of the secondary icon. Confusing? Sure, that's why I call it "overlay" here: because as far as it's been used thus far, it has been for an optional overlay image. We'll see if that holds up, but at least for now it explains what this image is a bit better. |
| secondarySpecial | string | Pulled from the Secondary Icon, this is the "special" background for the item. For Emblems, this is the background image used on the Details view: but it need not be limited to that for other types of items. |
| backgroundColor | DestinyColor | Sometimes, an item will have a background color. Most notably this occurs with Emblems, who use the Background Color for small character nameplates such as the "friends" view you see in-game. There are almost certainly other items that have background color as well, though I have not bothered to investigate what items have it nor what purposes they serve: use it as you will. |
| screenshot | string | If we were able to acquire an in-game screenshot for the item, the path to that screenshot will be returned here. Note that not all items have screenshots: particularly not any non-equippable items. |
| itemTypeDisplayName | string | The localized title/name of the item's type. This can be whatever the designers want, and has no guarantee of consistency between items. |
| itemTypeAndTierDisplayName | string | It became a common enough pattern in our UI to show Item Type and Tier combined into a single localized string that I'm just going to go ahead and start pre-creating these for items. |
| displaySource | string | In theory, it is a localized string telling you about how you can find the item. I really wish this was more consistent. Many times, it has nothing. Sometimes, it's instead a more narrative-forward description of the item. Which is cool, and I wish all properties had that data, but it should really be its own property. |
| tooltipStyle | string | An identifier that the game UI uses to determine what type of tooltip to show for the item. These have no corresponding definitions that BNet can link to: so it'll be up to you to interpret and display your UI differently according to these styles (or ignore it). |
| action | DestinyItemActionBlockDefinition:Definition | If the item can be "used", this block will be non-null, and will have data related to the action performed when using the item. (Guess what? 99% of the time, this action is "dismantle". Shocker) |
| inventory | DestinyItemInventoryBlockDefinition:Definition | If this item can exist in an inventory, this block will be non-null. In practice, every item that currently exists has one of these blocks. But note that it is not necessarily guaranteed. |
| setData | DestinyItemSetBlockDefinition:Definition | If this item is a quest, this block will be non-null. In practice, I wish I had called this the Quest block, but at the time it wasn't clear to me whether it would end up being used for purposes other than quests. It will contain data about the steps in the quest, and mechanics we can use for displaying and tracking the quest. |
| stats | DestinyItemStatBlockDefinition:Definition | If this item can have stats (such as a weapon, armor, or vehicle), this block will be non-null and populated with the stats found on the item. |
| equippingBlock | DestinyEquippingBlockDefinition:Definition | If this item can be equipped, this block will be non-null and will be populated with the conditions under which it can be equipped. |
| translationBlock | DestinyItemTranslationBlockDefinition:Definition | If this item can be rendered, this block will be non-null and will be populated with rendering information. |
| preview | DestinyItemPreviewBlockDefinition:Definition | If this item can be Used or Acquired to gain other items (for instance, how Eververse Boxes can be consumed to get items from the box), this block will be non-null and will give summary information for the items that can be acquired. |
| quality | DestinyItemQualityBlockDefinition:Definition | If this item can have a level or stats, this block will be non-null and will be populated with default quality (item level, "quality", and infusion) data. See the block for more details, there's often less upfront information in D2 so you'll want to be aware of how you use quality and item level on the definition level now. |
| value | DestinyItemValueBlockDefinition:Definition | The conceptual "Value" of an item, if any was defined. See the DestinyItemValueBlockDefinition for more details. |
| sourceData | DestinyItemSourceBlockDefinition:Definition | If this item has a known source, this block will be non-null and populated with source information. Unfortunately, at this time we are not generating sources: that is some aggressively manual work which we didn't have time for, and I'm hoping to get back to at some point in the future. |
| objectives | DestinyItemObjectiveBlockDefinition:Definition | If this item has Objectives (extra tasks that can be accomplished related to the item... most frequently when the item is a Quest Step and the Objectives need to be completed to move on to the next Quest Step), this block will be non-null and the objectives defined herein. |
| plug | DestinyItemPlugDefinition:Definition | If this item is a Plug, this will be non-null and the info defined herein. See DestinyItemPlugDefinition for more information. |
| gearset | DestinyItemGearsetBlockDefinition:Definition | If this item has related items in a "Gear Set", this will be non-null and the relationships defined herein. |
| sack | DestinyItemSackBlockDefinition:Definition | If this item is a "reward sack" that can be opened to provide other items, this will be non-null and the properties of the sack contained herein. |
| sockets | DestinyItemSocketBlockDefinition:Definition | If this item has any Sockets, this will be non-null and the individual sockets on the item will be defined herein. |
| summary | DestinyItemSummaryBlockDefinition:Definition | Summary data about the item. |
| talentGrid | DestinyItemTalentGridBlockDefinition:Definition | If the item has a Talent Grid, this will be non-null and the properties of the grid defined herein. Note that, while many items still have talent grids, the only ones with meaningful Nodes still on them will be Subclass/"Build" items. |
| investmentStats | DestinyItemInvestmentStatDefinition:Definition[] | If the item has stats, this block will be defined. It has the "raw" investment stats for the item. These investment stats don't take into account the ways that the items can spawn, nor do they take into account any Stat Group transformations. I have retained them for debugging purposes, but I do not know how useful people will find them. |
| perks | DestinyItemPerkEntryDefinition:Definition[] | If the item has any intrinsic Perks (Perks that it will provide regardless of Sockets, Talent Grid, and other transitory state), they will be defined here. |
| loreHash | Destiny.Definitions.Lore.DestinyLoreDefinition:integer:uint32:nullable | If the item has any related Lore (DestinyLoreDefinition), this will be the hash identifier you can use to look up the lore definition. |
| summaryItemHash | Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32:nullable | There are times when the game will show you a "summary/vague" version of an item - such as a description of its type represented as a DestinyInventoryItemDefinition - rather than display the item itself. This happens sometimes when summarizing possible rewards in a tooltip. This is the item displayed instead, if it exists. |
| animations | DestinyAnimationReference:Definition[] | If any animations were extracted from game content for this item, these will be the definitions of those animations. |
| allowActions | boolean | BNet may forbid the execution of actions on this item via the API. If that is occurring, allowActions will be set to false. |
| links | HyperlinkReference[] | If we added any help or informational URLs about this item, these will be those links. |
| doesPostmasterPullHaveSideEffects | boolean | The boolean will indicate to us (and you!) whether something could happen when you transfer this item from the Postmaster that might be considered a "destructive" action. It is not feasible currently to tell you (or ourelves!) in a consistent way whether this will actually cause a destructive action, so we are playing it safe: if it has the potential to do so, we will not allow it to be transferred from the Postmaster by default. You will need to check for this flag before transferring an item from the Postmaster, or else you'll end up receiving an error. |
| nonTransferrable | boolean | The intrinsic transferability of an item. I hate that this boolean is negative - but there's a reason. Just because an item is intrinsically transferrable doesn't mean that it can be transferred, and we don't want to imply that this is the only source of that transferability. |
| itemCategoryHashes | Destiny.Definitions.DestinyItemCategoryDefinition:integer:uint32[] | BNet attempts to make a more formal definition of item "Categories", as defined by DestinyItemCategoryDefinition. This is a list of all Categories that we were able to algorithmically determine that this item is a member of. (for instance, that it's a "Weapon", that it's an "Auto Rifle", etc...) The algorithm for these is, unfortunately, volatile. If you believe you see a miscategorized item, please let us know on the Bungie API forums. |
| specialItemType | SpecialItemType:Enum | In Destiny 1, we identified some items as having particular categories that we'd like to know about for various internal logic purposes. These are defined in SpecialItemType, and while these days the itemCategoryHashes are the preferred way of identifying types, we have retained this enum for its convenience. |
| itemType | DestinyItemType:Enum | A value indicating the "base" the of the item. This enum is a useful but dramatic oversimplification of what it means for an item to have a "Type". Still, it's handy in many situations. itemCategoryHashes are the preferred way of identifying types, we have retained this enum for its convenience. |
| itemSubType | DestinyItemSubType:Enum | A value indicating the "sub-type" of the item. For instance, where an item might have an itemType value "Weapon", this will be something more specific like "Auto Rifle". itemCategoryHashes are the preferred way of identifying types, we have retained this enum for its convenience. |
| classType | DestinyClass:Enum | We run a similarly weak-sauce algorithm to try and determine whether an item is restricted to a specific class. If we find it to be restricted in such a way, we set this classType property to match the class' enumeration value so that users can easily identify class restricted items. If you see a mis-classed item, please inform the developers in the Bungie API forum. |
| equippable | boolean | If true, then you will be allowed to equip the item if you pass its other requirements. This being false means that you cannot equip the item under any circumstances. |
| damageTypeHashes | Destiny.Definitions.DestinyDamageTypeDefinition:integer:uint32[] | Theoretically, an item can have many possible damage types. In practice, this is not true, but just in case weapons start being made that have multiple (for instance, an item where a socket has reusable plugs for every possible damage type that you can choose from freely), this field will return all of the possible damage types that are available to the weapon by default. |
| damageTypes | DamageType:Enum[] | This is the list of all damage types that we know ahead of time the item can take on. Unfortunately, this does not preclude the possibility of something funky happening to give the item a damage type that cannot be predicted beforehand: for example, if some designer decides to create arbitrary non-reusable plugs that cause damage type to change. This damage type prediction will only use the following to determine potential damage types: - Intrinsic perks - Talent Node perks - Known, reusable plugs for sockets |
| defaultDamageType | DamageType:Enum | If the item has a damage type that could be considered to be default, it will be populated here. For various upsetting reasons, it's surprisingly cumbersome to figure this out. I hope you're happy. |
| defaultDamageTypeHash | Destiny.Definitions.DestinyDamageTypeDefinition:integer:uint32:nullable | Similar to defaultDamageType, but represented as the hash identifier for a DestinyDamageTypeDefinition. I will likely regret leaving in the enumeration versions of these properties, but for now they're very convenient. |
| hash | integer:uint32 | The unique identifier for this entity. Guaranteed to be unique for the type of entity, but not globally. When entities refer to each other in Destiny content, it is this hash that they are referring to. |
| index | integer:int32 | The index of the entity as it was found in the investment tables. |
| redacted | boolean | If this is true, then there is an entity with this identifier/type combination, but BNet is not yet allowed to show it. Sorry! |
Example
{
// Type: DestinyDisplayPropertiesDefinition:Definition
"displayProperties": {
// Type: string
"description": "",
// Type: string
"name": "",
// Type: string
"icon": "",
// Type: boolean
"hasIcon": false
},
// Type: string
"secondaryIcon": "",
// Type: string
"secondaryOverlay": "",
// Type: string
"secondarySpecial": "",
// Type: DestinyColor
"backgroundColor": {},
// Type: string
"screenshot": "",
// Type: string
"itemTypeDisplayName": "",
// Type: string
"itemTypeAndTierDisplayName": "",
// Type: string
"displaySource": "",
// Type: string
"tooltipStyle": "",
// Type: DestinyItemActionBlockDefinition:Definition
"action": {},
// Type: DestinyItemInventoryBlockDefinition:Definition
"inventory": {},
// Type: DestinyItemSetBlockDefinition:Definition
"setData": {},
// Type: DestinyItemStatBlockDefinition:Definition
"stats": {},
// Type: DestinyEquippingBlockDefinition:Definition
"equippingBlock": {},
// Type: DestinyItemTranslationBlockDefinition:Definition
"translationBlock": {},
// Type: DestinyItemPreviewBlockDefinition:Definition
"preview": {},
// Type: DestinyItemQualityBlockDefinition:Definition
"quality": {},
// Type: DestinyItemValueBlockDefinition:Definition
"value": {},
// Type: DestinyItemSourceBlockDefinition:Definition
"sourceData": {},
// Type: DestinyItemObjectiveBlockDefinition:Definition
"objectives": {},
// Type: DestinyItemPlugDefinition:Definition
"plug": {},
// Type: DestinyItemGearsetBlockDefinition:Definition
"gearset": {},
// Type: DestinyItemSackBlockDefinition:Definition
"sack": {},
// Type: DestinyItemSocketBlockDefinition:Definition
"sockets": {},
// Type: DestinyItemSummaryBlockDefinition:Definition
"summary": {},
// Type: DestinyItemTalentGridBlockDefinition:Definition
"talentGrid": {},
// Type: DestinyItemInvestmentStatDefinition:Definition[]
"investmentStats": [
// Type: DestinyItemInvestmentStatDefinition:Definition
{
// Type: Destiny.Definitions.DestinyStatDefinition:integer:uint32
"statTypeHash": 0,
// Type: integer:int32
"value": 0
}
],
// Type: DestinyItemPerkEntryDefinition:Definition[]
"perks": [
// Type: DestinyItemPerkEntryDefinition:Definition
{
// Type: string
"requirementDisplayString": "",
// Type: Destiny.Definitions.DestinySandboxPerkDefinition:integer:uint32
"perkHash": 0
}
],
// Type: Destiny.Definitions.Lore.DestinyLoreDefinition:integer:uint32:nullable
"loreHash": 0,
// Type: Destiny.Definitions.DestinyInventoryItemDefinition:integer:uint32:nullable
"summaryItemHash": 0,
// Type: DestinyAnimationReference:Definition[]
"animations": [
// Type: DestinyAnimationReference:Definition
{
// Type: string
"animName": "",
// Type: string
"animIdentifier": "",
// Type: string
"path": ""
}
],
// Type: boolean
"allowActions": false,
// Type: HyperlinkReference[]
"links": [
// Type: HyperlinkReference
{
// Type: string
"title": "",
// Type: string
"url": ""
}
],
// Type: boolean
"doesPostmasterPullHaveSideEffects": false,
// Type: boolean
"nonTransferrable": false,
// Type: Destiny.Definitions.DestinyItemCategoryDefinition:integer:uint32[]
"itemCategoryHashes": [
// Type: integer:uint32
0
],
// Type: SpecialItemType:Enum
"specialItemType": {},
// Type: DestinyItemType:Enum
"itemType": {},
// Type: DestinyItemSubType:Enum
"itemSubType": {},
// Type: DestinyClass:Enum
"classType": {},
// Type: boolean
"equippable": false,
// Type: Destiny.Definitions.DestinyDamageTypeDefinition:integer:uint32[]
"damageTypeHashes": [
// Type: integer:uint32
0
],
// Type: DamageType:Enum[]
"damageTypes": [
// Type: DamageType:Enum
0
],
// Type: DamageType:Enum
"defaultDamageType": {},
// Type: Destiny.Definitions.DestinyDamageTypeDefinition:integer:uint32:nullable
"defaultDamageTypeHash": 0,
// Type: integer:uint32
"hash": 0,
// Type: integer:int32
"index": 0,
// Type: boolean
"redacted": false
}