bungie-net-core
Version:
An easy way to interact with the Bungie.net API
51 lines (50 loc) • 2.35 kB
TypeScript
/**
* Bungie.Net API
* These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
*
* Contact: support@bungie.com
*
* NOTE: This class is auto generated by the bungie-net-core code generator program
* Repository: {@link https://github.com/owens1127/bungie-net-core}
* Do not edit these files manually.
*/
import { DestinyMilestoneActivityVariantDefinition } from './DestinyMilestoneActivityVariantDefinition';
/**
* Milestones can have associated activities which provide additional information
* about the context, challenges, modifiers, state etc... related to this Milestone.
*
*
* Information we need to be able to return that data is defined here, along with
* Tier data to establish a relationship between a conceptual Activity and its
* difficulty levels and variants.
* @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Definitions.Milestones.DestinyMilestoneActivityDefinition}
*/
export interface DestinyMilestoneActivityDefinition {
/**
* The "Conceptual" activity hash. Basically, we picked the lowest level activity
* and are treating it as the canonical definition of the activity for rendering
* purposes.
*
* If you care about the specific difficulty modes and variations, use the
* activities under "Variants". Mapped to DestinyActivityDefinition in the manifest.
*/
readonly conceptualActivityHash: number;
/**
* A milestone-referenced activity can have many variants, such as Tiers or
* alternative modes of play.
*
* Even if there is only a single variant, the details for these are represented
* within as a variant definition.
*
* It is assumed that, if this DestinyMilestoneActivityDefinition is active, then
* all variants should be active.
*
* If a Milestone could ever split the variants' active status conditionally, they
* should all have their own DestinyMilestoneActivityDefinition instead! The
* potential duplication will be worth it for the obviousness of processing and use.
* Mapped to DestinyActivityDefinition in the manifest.
*/
readonly variants: {
[key: number]: DestinyMilestoneActivityVariantDefinition;
};
}