warframe-worldstate-parser
Version:
An Open parser for Warframe's Worldstate in Javascript
54 lines (53 loc) • 1.51 kB
TypeScript
/**
* Represents an alert
* @augments {WorldstateObject}
*/
export default class Nightwave extends WorldstateObject {
/**
* @param {object} data The alert data
* @param {object} deps The dependencies object
* @param {string} deps.locale Locale to use for translations
*/
constructor(data: object, { locale }?: {
locale: string;
});
id: string;
/**
* The current season. 0-indexed.
* @type {number}
*/
season: number;
/**
* Descriptor for affiliation
* @type {string}
*/
tag: string;
/**
* The current season's current phase. 0-indexed.
* @type {number}
*/
phase: number;
/**
* Misc params provided.
* @type {object}
*/
params: object;
possibleChallenges: any;
activeChallenges: any;
/**
* An array containing the types of all of the alert's rewards
* @type {Array.<string>}
*/
rewardTypes: Array<string>;
/**
* Get a string indicating how much time is left before the alert expires
* @returns {string} estimated timer of the alert
*/
getETAString(): string;
/**
* Get an array containing the types of all of the nightwave season's rewards
* @returns {Array.<string>} an array containing the types of all of the nightwave season's rewards
*/
getRewardTypes(): Array<string>;
}
import WorldstateObject from './WorldstateObject.js';