bungie-net-core
Version:
An easy way to interact with the Bungie.net API
59 lines (58 loc) • 2.75 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 { InterpolationPointFloat } from '../../../Interpolation/InterpolationPointFloat';
/**
* These are pre-constructed collections of data that can be used to determine the
* Level Requirement for an item given a Progression to be tested (such as the
* Character's level).
*
* For instance, say a character receives a new Auto Rifle, and that Auto Rifle's
* DestinyInventoryItemDefinition.quality.progressionLevelRequirementHash property
* is pointing at one of these DestinyProgressionLevelRequirementDefinitions. Let's
* pretend also that the progressionHash it is pointing at is the Character Level
* progression. In that situation, the character's level will be used to
* interpolate a value in the requirementCurve property. The value picked up from
* that interpolation will be the required level for the item.
* @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Definitions.Progression.DestinyProgressionLevelRequirementDefinition}
*/
export interface DestinyProgressionLevelRequirementDefinition {
/**
* A curve of level requirements, weighted by the related progressions' level.
*
* Interpolate against this curve with the character's progression level to
* determine what the level requirement of the generated item that is using this
* data will be.
*/
readonly requirementCurve: InterpolationPointFloat[];
/**
* The progression whose level should be used to determine the level requirement.
*
* Look up the DestinyProgressionDefinition with this hash for more information
* about the progression in question. Mapped to DestinyProgressionDefinition in the
* manifest.
*/
readonly progressionHash: 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;
}