bungie-net-core
Version:
An easy way to interact with the Bungie.net API
44 lines (43 loc) • 2 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 { DestinyActivityInteractableEntryDefinition } from './DestinyActivityInteractableEntryDefinition';
/**
* There are times in every Activity's life when interacting with an object in the
* world will result in another Activity activating. Well, not every Activity. Just
* certain ones.
*
* Anyways, this defines a set of interactable components, the activities that they
* spawn when you interact with them, and the conditions under which they can be
* interacted with.
*
* Sadly, we don't get any *really* good data for them, like positional data... yet.
* I have hopes for future data that we could put on this.
* @see {@link https://bungie-net.github.io/#/components/schemas/Destiny.Definitions.Activities.DestinyActivityInteractableDefinition}
*/
export interface DestinyActivityInteractableDefinition {
/** The possible interactables in this activity interactable definition. */
readonly entries: DestinyActivityInteractableEntryDefinition[];
/**
* 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;
}