bungie-net-core/models/Destiny/Definitions/DestinyProgressionDefinition.d.ts

An easy way to interact with the Bungie.net API

/**
 * 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 { DestinyProgressionDisplayPropertiesDefinition } from './DestinyProgressionDisplayPropertiesDefinition';
import { DestinyProgressionScope } from '../DestinyProgressionScope';
import { DestinyProgressionStepDefinition } from './DestinyProgressionStepDefinition';
import { DestinyColor } from '../Misc/DestinyColor';
import { DestinyProgressionRewardItemQuantity } from './DestinyProgressionRewardItemQuantity';
/**
 * A "Progression" in Destiny is best explained by an example.
 *
 * A Character's "Level" is a progression: it has Experience that can be earned,
 * levels that can be gained, and is evaluated and displayed at various points in
 * the game. A Character's "Faction Reputation" is also a progression for much the
 * same reason.
 *
 * Progression is used by a variety of systems, and the definition of a Progression
 * will generally only be useful if combining with live data (such as a character's
 * DestinyCharacterProgressionComponent.progressions property, which holds that
 * character's live Progression states).
 *
 * Fundamentally, a Progression measures your "Level" by evaluating the thresholds
 * in its Steps (one step per level, except for the last step which can be repeated
 * indefinitely for "Levels" that have no ceiling) against the total earned "
 * progression points"/experience. (for simplicity purposes, we will henceforth
 * refer to earned progression points as experience, though it need not be a
 * mechanic that in any way resembles Experience in a traditional sense).
 *
 * Earned experience is calculated in a variety of ways, determined by the
 * Progression's scope. These go from looking up a stored value to performing
 * exceedingly obtuse calculations. This is why we provide live data in
 * DestinyCharacterProgressionComponent.progressions, so you don't have to worry
 * about those.
 * @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Definitions.DestinyProgressionDefinition}
 */
export interface DestinyProgressionDefinition {
    readonly displayProperties: DestinyProgressionDisplayPropertiesDefinition;
    /**
     * The "Scope" of the progression indicates the source of the progression's live
     * data.
     *
     * See the DestinyProgressionScope enum for more info: but essentially, a
     * Progression can either be backed by a stored value, or it can be a calculated
     * derivative of other values.
     */
    readonly scope: DestinyProgressionScope;
    /** If this is True, then the progression doesn't have a maximum level. */
    readonly repeatLastStep: boolean;
    /**
     * If there's a description of how to earn this progression in the local config,
     * this will be that localized description.
     */
    readonly source: string;
    /**
     * Progressions are divided into Steps, which roughly equate to "Levels" in the
     * traditional sense of a Progression. Notably, the last step can be repeated
     * indefinitely if repeatLastStep is true, meaning that the calculation for your
     * level is not as simple as comparing your current progress to the max progress of
     * the steps.
     *
     * These and more calculations are done for you if you grab live character
     * progression data, such as in the DestinyCharacterProgressionComponent.
     */
    readonly steps: DestinyProgressionStepDefinition[];
    /**
     * If true, the Progression is something worth showing to users.
     *
     * If false, BNet isn't going to show it. But that doesn't mean you can't. We're
     * all friends here.
     */
    readonly visible: boolean;
    /**
     * If the value exists, this is the hash identifier for the Faction that owns this
     * Progression.
     *
     * This is purely for convenience, if you're looking at a progression and want to
     * know if and who it's related to in terms of Faction Reputation. Mapped to
     * DestinyFactionDefinition in the manifest.
     */
    readonly factionHash?: number;
    /** The #RGB string value for the color related to this progression, if there is one. */
    readonly color: DestinyColor;
    /**
     * For progressions that have it, this is the rank icon we use in the Companion,
     * displayed above the progressions' rank value.
     */
    readonly rankIcon: string;
    readonly rewardItems: DestinyProgressionRewardItemQuantity[];
    /**
     * 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.
     */
    readonly hash: number;
    /** The index of the entity as it was found in the investment tables. */
    readonly index: number;
    /**
     * If this is true, then there is an entity with this identifier/type combination,
     * but BNet is not yet allowed to show it. Sorry!
     */
    readonly redacted: boolean;
}