DestinyVendorDefinition class
These are the definitions for Vendors.
In Destiny, a Vendor can be a lot of things - some things that you wouldn't expect, and some things that you don't even see directly in the game. Vendors are the Dolly Levi of the Destiny universe.
-
Traditional Vendors as you see in game: people who you come up to and who give you quests, rewards, or who you can buy things from.
-
Kiosks/Collections, which are really just Vendors that don't charge currency ( or charge some pittance of a currency) and whose gating for purchases revolves more around your character's state.
-
Previews for rewards or the contents of sacks. These are implemented as Vendors, where you can't actually purchase from them but the items that they have for sale and the categories of sale items reflect the rewards or contents of the sack. This is so that the game could reuse the existing Vendor display UI for rewards and save a bunch of wheel reinvention.
-
Item Transfer capabilities, like the Vault and Postmaster. Vendors can have " acceptedItem" buckets that determine the source and destination buckets for transfers. When you interact with such a vendor, these buckets are what gets shown in the UI instead of any items that the Vendor would have for sale. Yep, the Vault is a vendor.
It is pretty much guaranteed that they'll be used for even more features in the future. They have come to be seen more as generic categorized containers for items than "vendors" in a traditional sense, for better or worse.
Where possible and time allows, we'll attempt to split those out into their own more digestible derived "Definitions": but often time does not allow that, as you can see from the above ways that vendors are used which we never split off from Vendor Definitions externally.
Since Vendors are so many things to so many parts of the game, the definition is understandably complex. You will want to combine this data with live Vendor information from the API when it is available.
Constructors
Properties
-
acceptedItems
↔ List<
DestinyVendorAcceptedItemDefinition> -
If the Vendor is actually a vehicle for the transferring of items (like the
Vault and Postmaster vendors), this defines the list of source->destination
buckets for transferring.
read / write
-
actions
↔ List<
DestinyVendorActionDefinition> -
Describes "actions" that can be performed on a vendor. Currently, none of these
exist. But theoretically a Vendor could let you interact with it by performing
actions. We'll see what these end up looking like if they ever get used.
read / write
- buyString ↔ String
-
If the vendor has a custom localized string describing the "buy" action, that is
returned here.
read / write
-
categories
↔ List<
DestinyVendorCategoryEntryDefinition> -
These are the headers for sections of items that the vendor is selling. When you
see items organized by category in the header, it is these categories that it is
showing. [...]
read / write
- consolidateCategories ↔ bool
-
If TRUE, consolidate categories that only differ by trivial properties (such as
having minor differences in name)
read / write
-
displayCategories
↔ List<
DestinyDisplayCategoryDefinition> -
Display Categories are different from "categories" in that these are
specifically for visual grouping and display of categories in Vendor UI. [...]
read / write
- displayItemHash ↔ int
-
If the vendor has an item that should be displayed as the "featured" item, this
is the hash identifier for that DestinyVendorItemDefinition. [...]
read / write
- displayProperties ↔ DestinyVendorDisplayPropertiesDefinition
-
read / write
- enabled ↔ bool
-
If a vendor is not enabled, we won't even save the vendor's definition, and we
won't return any items or info about them. It's as if they don't exist.
read / write
- factionHash ↔ int
-
If the Vendor has a faction, this hash will be valid and point to a
DestinyFactionDefinition. [...]
read / write
-
failureStrings
↔ List<
String> -
If an item can't be purchased from the vendor, there may be many "custom"/game
state specific reasons why not. [...]
read / write
-
groups
↔ List<
DestinyVendorGroupReference> -
A vendor can be a part of 0 or 1 "groups" at a time: a group being a collection
of Vendors related by either location or function/purpose. It's used for our our
Companion Vendor UI. Only one of these can be active for a Vendor at a time.
read / write
- hash ↔ int
-
The unique identifier for this entity. Guaranteed to be unique for the type of
entity, but not globally. [...]
read / write
-
ignoreSaleItemHashes
↔ List<
int> -
Some items don't make sense to return in the API, for example because they
represent an action to be performed rather than an item being sold. I'd rather
we not do this, but at least in the short term this is a workable workaround.
read / write
- index ↔ int
-
The index of the entity as it was found in the investment tables.
read / write
- inhibitBuying ↔ bool
-
If this is true, you aren't allowed to buy whatever the vendor is selling.
read / write
- inhibitSelling ↔ bool
-
If this is true, you're not allowed to sell whatever the vendor is buying.
read / write
-
interactions
↔ List<
DestinyVendorInteractionDefinition> -
In addition to selling items, vendors can have "interactions": UI where you "
talk" with the vendor and they offer you a reward, some item, or merely
acknowledge via dialog that you did something cool.
read / write
-
inventoryFlyouts
↔ List<
DestinyVendorInventoryFlyoutDefinition> -
If the vendor shows you items from your own inventory - such as the Vault vendor
does - this data describes the UI around showing those inventory buckets and
which ones get shown.
read / write
-
itemList
↔ List<
DestinyVendorItemDefinition> -
If the vendor sells items (or merely has a list of items to show like the "Sack"
vendors do), this is the list of those items that the vendor can sell. From this
list, only a subset will be available from the vendor at any given time,
selected randomly and reset on the vendor's refresh interval. [...]
read / write
-
locations
↔ List<
DestinyVendorLocationDefinition> -
A vendor can be at different places in the world depending on the game/character/
account state. This is the list of possible locations for the vendor, along with
conditions we use to determine which one is currently active.
read / write
-
originalCategories
↔ List<
DestinyVendorCategoryEntryDefinition> -
See the categories property for a description of categories and why
originalCategories exists.
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
- resetIntervalMinutes ↔ int
-
A number used for calculating the frequency of a vendor's inventory resetting/
refreshing. [...]
read / write
- resetOffsetMinutes ↔ int
-
Again, used for reset/refreshing of inventory. Don't worry too much about it.
Unless you want to.
read / write
- returnWithVendorRequest ↔ bool
-
As many of you know, Vendor data has historically been pretty brutal on the BNet
servers. In an effort to reduce this workload, only Vendors with this flag set
will be returned on Vendor requests. This allows us to filter out Vendors that
don't dynamic data that's particularly useful: things like "Preview/Sack"
vendors, for example, that you can usually suss out the details for using just
the definitions themselves.
read / write
- sellString ↔ String
-
Ditto for selling. Not that you can sell items to a vendor anymore. Will it come
back? Who knows. The string's still there.
read / write
-
services
↔ List<
DestinyVendorServiceDefinition> -
BNet doesn't use this data yet, but it appears to be an optional list of flavor
text about services that the Vendor can provide.
read / write
-
unlockRanges
↔ List<
DateRange> -
If we were able to predict the dates when this Vendor will be visible/available,
this will be the list of those date ranges. Sadly, we're not able to predict
this very frequently, so this will often be useless data.
read / write
- vendorBanner ↔ String
-
If the vendor has a custom banner image, that can be found here.
read / write
- vendorIdentifier ↔ String
-
The internal identifier for the Vendor. A holdover from the old days of Vendors,
but we don't have time to refactor it away.
read / write
- vendorPortrait ↔ String
-
A portrait of the Vendor's smiling mug. Or frothing tentacles.
read / write
- vendorSubcategoryIdentifier ↔ String
-
The identifier of the VendorCategoryDefinition for this vendor's subcategory.
read / write
- visible ↔ bool
-
If a vendor is not visible, we still have and will give vendor definition info,
but we won't use them for things like Advisors or UI.
read / write
- hashCode → int
-
The hash code for this object.
read-only, inherited
- 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 ==(
dynamic other ) → bool -
The equality operator.
inherited