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 Alert extends WorldstateObject {
/**
* @param {object} data The alert data
* @param {string} locale Locale to use for translations
*/
constructor(data: object, { locale }?: string);
/**
* The mission that the players have to complete
* @type {Mission}
*/
mission: Mission;
/**
* ETA string (at time of object creation)
* @type {string}
*/
eta: string;
/**
* An array containing the types of all of the alert's rewards
* @type {Array.<string>}
*/
rewardTypes: Array<string>;
/**
* A tag that DE occasionally provides, such as `LotusGift`
* @type {string}
*/
tag: string;
/**
* Get the alert's description text
* @returns {string} the description
*/
getDescription(): string;
/**
* Get the alert's reward
* @returns {Reward} the reward
*/
getReward(): Reward;
/**
* Get a string indicating how much time is left before the alert expires
* @returns {string} the time left
*/
getETAString(): string;
/**
* Get an array containing the types of all of the alert's rewards
* @returns {Array.<string>} an array containing the types of all of the alert's rewards
*/
getRewardTypes(): Array<string>;
}
import WorldstateObject from './WorldstateObject.js';
import Mission from './Mission.js';