bungie-net-core
Version:
An easy way to interact with the Bungie.net API
42 lines (41 loc) • 1.73 kB
TypeScript
/**
* 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.
*/
/**
* An artificial construct of our own creation, to try and put some order on top of
* Medals and keep them from being one giant, unmanageable and unsorted blob of
* stats.
*
* Unfortunately, we haven't had time to do this evaluation yet in Destiny 2, so we'
* re short on Medal Tiers. This will hopefully be updated over time, if Medals
* continue to exist.
* @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Definitions.DestinyMedalTierDefinition}
*/
export interface DestinyMedalTierDefinition {
/** The name of the tier. */
readonly tierName: string;
/** If you're rendering medals by tier, render them in this order (ascending) */
readonly order: number;
/**
* 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;
}