bungie-net-core/models/Destiny/DestinyGatingScope.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.
 */
/**
 * This enumeration represents the most restrictive type of gating that is being
 * performed by an entity. This is useful as a shortcut to avoid a lot of lookups
 * when determining whether the gating on an Entity applies to everyone equally, or
 * to their specific Profile or Character states.
 *
 * None = There is no gating on this item.
 *
 * Global = The gating on this item is based entirely on global game state. It will
 * be gated the same for everyone.
 *
 * Clan = The gating on this item is at the Clan level. For instance, if you're
 * gated by Clan level this will be the case.
 *
 * Profile = The gating includes Profile-specific checks, but not on the Profile's
 * characters. An example of this might be when you acquire an Emblem: the Emblem
 * will be available in your Kiosk for all characters in your Profile from that
 * point onward.
 *
 * Character = The gating includes Character-specific checks, including character
 * level restrictions. An example of this might be an item that you can't purchase
 * from a Vendor until you reach a specific Character Level.
 *
 * Item = The gating includes item-specific checks. For BNet, this generally
 * implies that we'll show this data only on a character level or deeper.
 *
 * AssumedWorstCase = The unlocks and checks being used for this calculation are of
 * an unknown type and are used for unknown purposes. For instance, if some great
 * person decided that an unlock value should be globally scoped, but then the game
 * changes it using character-specific data in a way that BNet doesn't know about.
 * Because of the open-ended potential for this to occur, many unlock checks for "
 * globally" scoped unlock data may be assumed as the worst case unless it has been
 * specifically whitelisted as otherwise. That sucks, but them's the breaks.
 * @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.DestinyGatingScope}
 */
export declare enum DestinyGatingScope {
    None = 0,
    Global = 1,
    Clan = 2,
    Profile = 3,
    Character = 4,
    Item = 5,
    AssumedWorstCase = 6
}