/**
 * 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 { DestinyDisplayPropertiesDefinition } from './Common/DestinyDisplayPropertiesDefinition';
import { DestinyGatingScope } from '../DestinyGatingScope';
import { DestinyUnlockValueUIStyle } from '../DestinyUnlockValueUIStyle';
import { DestinyObjectivePerkEntryDefinition } from './DestinyObjectivePerkEntryDefinition';
import { DestinyObjectiveStatEntryDefinition } from './DestinyObjectiveStatEntryDefinition';
import { DestinyObjectiveUiStyle } from '../DestinyObjectiveUiStyle';
/**
 * Defines an "Objective".
 *
 * An objective is a specific task you should accomplish in the game. These are
 * referred to by:
 *
 * - Quest Steps (which are DestinyInventoryItemDefinition entities with Objectives)
 *
 * - Challenges (which are Objectives defined on an DestinyActivityDefintion)
 *
 * - Milestones (which refer to Objectives that are defined on both Quest Steps and
 * Activities)
 *
 * - Anything else that the designers decide to do later.
 *
 * Objectives have progress, a notion of having been Completed, human readable data
 * describing the task to be accomplished, and a lot of optional tack-on data that
 * can enhance the information provided about the task.
 * @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Definitions.DestinyObjectiveDefinition}
 */
export interface DestinyObjectiveDefinition {
    /**
     * Ideally, this should tell you what your task is. I'm not going to lie to you
     * though. Sometimes this doesn't have useful information at all. Which sucks, but
     * there's nothing either of us can do about it.
     */
    readonly displayProperties: DestinyDisplayPropertiesDefinition;
    /**
     * The value that the unlock value defined in unlockValueHash must reach in order
     * for the objective to be considered Completed. Used in calculating progress and
     * completion status.
     */
    readonly completionValue: number;
    /**
     * A shortcut for determining the most restrictive gating that this Objective is
     * set to use. This includes both the dynamic determination of progress and of
     * completion values. See the DestinyGatingScope enum's documentation for more
     * details.
     */
    readonly scope: DestinyGatingScope;
    /**
     * OPTIONAL: a hash identifier for the location at which this objective must be
     * accomplished, if there is a location defined. Look up the
     * DestinyLocationDefinition for this hash for that additional location info.
     * Mapped to DestinyLocationDefinition in the manifest.
     */
    readonly locationHash: number;
    /** If true, the value is allowed to go negative. */
    readonly allowNegativeValue: boolean;
    /**
     * If true, you can effectively "un-complete" this objective if you lose progress
     * after crossing the completion threshold.
     *
     * If False, once you complete the task it will remain completed forever by locking
     * the value.
     */
    readonly allowValueChangeWhenCompleted: boolean;
    /**
     * If true, completion means having an unlock value less than or equal to the
     * completionValue.
     *
     * If False, completion means having an unlock value greater than or equal to the
     * completionValue.
     */
    readonly isCountingDownward: boolean;
    /**
     * The UI style applied to the objective. It's an enum, take a look at
     * DestinyUnlockValueUIStyle for details of the possible styles. Use this info as
     * you wish to customize your UI.
     *
     * DEPRECATED: This is no longer populated by Destiny 2 game content. Please use
     * inProgressValueStyle and completedValueStyle instead.
     */
    readonly valueStyle: DestinyUnlockValueUIStyle;
    /** Text to describe the progress bar. */
    readonly progressDescription: string;
    /**
     * If this objective enables Perks intrinsically, the conditions for that enabling
     * are defined here.
     */
    readonly perks: DestinyObjectivePerkEntryDefinition;
    /**
     * If this objective enables modifications on a player's stats intrinsically, the
     * conditions are defined here.
     */
    readonly stats: DestinyObjectiveStatEntryDefinition;
    /**
     * If nonzero, this is the minimum value at which the objective's progression
     * should be shown. Otherwise, don't show it yet.
     */
    readonly minimumVisibilityThreshold: number;
    /**
     * If True, the progress will continue even beyond the point where the objective
     * met its minimum completion requirements. Your UI will have to accommodate it.
     */
    readonly allowOvercompletion: boolean;
    /**
     * If True, you should continue showing the progression value in the UI after it's
     * complete. I mean, we already do that in BNet anyways, but if you want to be
     * better behaved than us you could honor this flag.
     */
    readonly showValueOnComplete: boolean;
    /** The style to use when the objective is completed. */
    readonly completedValueStyle: DestinyUnlockValueUIStyle;
    /** The style to use when the objective is still in progress. */
    readonly inProgressValueStyle: DestinyUnlockValueUIStyle;
    /**
     * Objectives can have arbitrary UI-defined identifiers that define the style
     * applied to objectives. For convenience, known UI labels will be defined in the
     * uiStyle enum value.
     */
    readonly uiLabel: string;
    /** If the objective has a known UI label value, this property will represent it. */
    readonly uiStyle: DestinyObjectiveUiStyle;
    /**
     * 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;
}