bungie-net-core/enums/Destiny/DestinyRecordState.d.ts

An easy way to interact with the Bungie.net API

/**
 * A Flags enumeration/bitmask where each bit represents a possible state that a
 * Record/Triumph can be in.
 *
 * This enum represents a set of flags - use bitwise operators to check which of
 * these match your value.
 * @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.DestinyRecordState}
 */
export declare const DestinyRecordState: {
    /**
     * If there are no flags set, the record is in a state where it *could* be redeemed,
     * but it has not been yet.
     */
    readonly None: 0;
    /** If this is set, the completed record has been redeemed. */
    readonly RecordRedeemed: 1;
    /**
     * If this is set, there's a reward available from this Record but it's unavailable
     * for redemption.
     */
    readonly RewardUnavailable: 2;
    /** If this is set, the objective for this Record has not yet been completed. */
    readonly ObjectiveNotCompleted: 4;
    /**
     * If this is set, the game recommends that you replace the display text of this
     * Record with DestinyRecordDefinition.stateInfo.obscuredDescription.
     */
    readonly Obscured: 8;
    /**
     * If this is set, the game recommends that you not show this record. Do what you
     * will with this recommendation.
     */
    readonly Invisible: 16;
    /**
     * If this is set, you can't complete this record because you lack some permission
     * that's required to complete it.
     */
    readonly EntitlementUnowned: 32;
    /**
     * If this is set, the record has a title (check DestinyRecordDefinition for title
     * info) and you can equip it.
     */
    readonly CanEquipTitle: 64;
};