bungie-net-core/models/Destiny/Quests/DestinyQuestStatus.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 { DestinyObjectiveProgress } from './DestinyObjectiveProgress';
/**
 * Data regarding the progress of a Quest for a specific character. Quests are
 * composed of multiple steps, each with potentially multiple objectives: this
 * QuestStatus will return Objective data for the *currently active* step in this
 * quest.
 * @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Quests.DestinyQuestStatus}
 */
export interface DestinyQuestStatus {
    /**
     * The hash identifier for the Quest Item. (Note: Quests are defined as Items, and
     * thus you would use this to look up the quest's DestinyInventoryItemDefinition).
     * For information on all steps in the quest, you can then examine its
     * DestinyInventoryItemDefinition.setData property for Quest Steps (which are *also*
     * items). You can use the Item Definition to display human readable data about
     * the overall quest. Mapped to DestinyInventoryItemDefinition in the manifest.
     */
    readonly questHash: number;
    /**
     * The hash identifier of the current Quest Step, which is also a
     * DestinyInventoryItemDefinition. You can use this to get human readable data
     * about the current step and what to do in that step. Mapped to
     * DestinyInventoryItemDefinition in the manifest.
     */
    readonly stepHash: number;
    /**
     * A step can have multiple objectives. This will give you the progress for each
     * objective in the current step, in the order in which they are rendered in-game.
     */
    readonly stepObjectives: DestinyObjectiveProgress[];
    /** Whether or not the quest is tracked */
    readonly tracked: boolean;
    /**
     * The current Quest Step will be an instanced item in the player's inventory. If
     * you care about that, this is the instance ID of that item.
     */
    readonly itemInstanceId: string;
    /**
     * Whether or not the whole quest has been completed, regardless of whether or not
     * you have redeemed the rewards for the quest.
     */
    readonly completed: boolean;
    /** Whether or not you have redeemed rewards for this quest. */
    readonly redeemed: boolean;
    /** Whether or not you have started this quest. */
    readonly started: boolean;
    /**
     * If the quest has a related Vendor that you should talk to in order to initiate
     * the quest/earn rewards/continue the quest, this will be the hash identifier of
     * that Vendor. Look it up its DestinyVendorDefinition.
     */
    readonly vendorHash?: number;
}