DestinyItemCategoryDefinition class

In an attempt to categorize items by type, usage, and other interesting properties, we created DestinyItemCategoryDefinition: information about types that is assembled using a set of heuristics that examine the properties of an item such as what inventory bucket it's in, its item type name, and whether it has or is missing certain blocks of data.

This heuristic is imperfect, however. If you find an item miscategorized, let us know on the Bungie API forums!

We then populate all of the categories that we think an item belongs to in its DestinyInventoryItemDefinition.itemCategoryHashes property. You can use that to provide your own custom item filtering, sorting, aggregating... go nuts on it! And let us know if you see more categories that you wish would be added!

Constructors

DestinyItemCategoryDefinition()

Properties

deprecated bool
If True, this category has been deprecated: it may have no items left, or there may be only legacy items that remain in it which are no longer relevant to the game.
read / write
displayProperties DestinyDisplayPropertiesDefinition
read / write
grantDestinyClass int
If an item belongs to this category, it will also get this class restriction enum value. [...]
read / write
grantDestinyItemType int
If an item belongs to this category, it will also receive this item type. This is now how DestinyItemType is populated for items: it used to be an even jankier process, but that's a story that requires more alcohol.
read / write
grantDestinySubType int
If an item belongs to this category, it will also receive this subtype enum value. [...]
read / write
groupCategoryOnly bool
If true, this category is only used for grouping, and should not be evaluated with its own checks. Rather, the item only has this category if it has one of its child categories.
read / write
groupedCategoryHashes List<int>
If this category is a "parent" category of other categories, those children will have their hashes listed in rendering order here, and can be looked up using these hashes against DestinyItemCategoryDefinition. [...]
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
itemTypeRegex String
The janky regular expression we used against the item type to try and discern whether the item belongs to this category.
read / write
itemTypeRegexNot String
If the item type matches this janky regex, it does not belong to this category.
read / write
originBucketIdentifier String
If the item belongs to this bucket, it does belong to this category.
read / write
parentCategoryHashes List<int>
All item category hashes of "parent" categories: categories that contain this as a child through the hierarchy of groupedCategoryHashes. It's a bit redundant, but having this child-centric list speeds up some calculations.
read / write
plugCategoryIdentifier String
If the item is a plug, this is the identifier we expect to find associated with it if it is in this category.
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
shortTitle String
A shortened version of the title. The reason why we have this is because the Armory in German had titles that were too long to display in our UI, so these were localized abbreviated versions of those categories. The property still exists today, even though the Armory doesn't exist for D2... yet.
read / write
visible bool
If True, this category should be visible in UI. Sometimes we make categories that we don't think are interesting externally. It's up to you if you want to skip on showing them.
read / write

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