bungie-net-core
Version:
An easy way to interact with the Bungie.net API
69 lines (68 loc) • 3.02 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.
*/
import { DestinyDisplayPropertiesDefinition } from '../Common/DestinyDisplayPropertiesDefinition';
/** @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Definitions.Loadouts.DestinyLoadoutConstantsDefinition} */
export interface DestinyLoadoutConstantsDefinition {
readonly displayProperties: DestinyDisplayPropertiesDefinition;
/**
* This is the same icon as the one in the display properties, offered here as well
* with a more descriptive name.
*/
readonly whiteIconImagePath: string;
/** This is a color-inverted version of the whiteIconImagePath. */
readonly blackIconImagePath: string;
/**
* The maximum number of loadouts available to each character. The loadouts
* component API response can return fewer loadouts than this, as more loadouts are
* unlocked by reaching higher Guardian Ranks.
*/
readonly loadoutCountPerCharacter: number;
/**
* A list of the socket category hashes to be filtered out of loadout item preview
* displays. Mapped to DestinySocketCategoryDefinition in the manifest.
*/
readonly loadoutPreviewFilterOutSocketCategoryHashes: number[];
/**
* A list of the socket type hashes to be filtered out of loadout item preview
* displays. Mapped to DestinySocketTypeDefinition in the manifest.
*/
readonly loadoutPreviewFilterOutSocketTypeHashes: number[];
/**
* A list of the loadout name hashes in index order, for convenience. Mapped to
* DestinyLoadoutNameDefinition in the manifest.
*/
readonly loadoutNameHashes: number[];
/**
* A list of the loadout icon hashes in index order, for convenience. Mapped to
* DestinyLoadoutIconDefinition in the manifest.
*/
readonly loadoutIconHashes: number[];
/**
* A list of the loadout color hashes in index order, for convenience. Mapped to
* DestinyLoadoutColorDefinition in the manifest.
*/
readonly loadoutColorHashes: 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;
}