warframe-worldstate-parser/types/lib/models/DarkSector.d.ts

An Open parser for Warframe's Worldstate in Javascript

/**
 * Represents a dark sector
 * @augments {WorldstateObject}
 */
export default class DarkSector extends WorldstateObject {
    /**
     * @param   {object}             data                  The dark sector data
     * @param   {object}             deps                  The dependencies object
     * @param   {string}             deps.locale           Locale to use for translations
     */
    constructor(data: object, { locale }?: {
        locale: string;
    });
    /**
     * The dark sector credit tax rate
     * @type {number}
     */
    creditTaxRate: number;
    /**
     * The dark sector credit tax rate for clan/alliance members
     * @type {number}
     */
    memberCreditsTaxRate: number;
    /**
     * The dark sector resource tax rate
     * @type {number}
     */
    itemsTaxRate: number;
    /**
     * The dark sector resource tax rate for clan/alliance members
     * @type {number}
     */
    memberItemsTaxRate: number;
    /**
     * Whether the dark sector holder is an alliance or not
     * @type {boolean}
     */
    isAlliance: boolean;
    /**
     * The current holder of the dark sector
     * @type {string}
     */
    defenderName: string;
    /**
     * The remaining health of the current solar rail
     * @type {number}
     */
    defenderPoolRemaining: number;
    /**
     * The maximum health of the solar rail
     * @type {number}
     */
    defenderMaxPool: number;
    /**
     * The date and time at which the rail was deployed
     * @type {Date}
     */
    defenderDeployemntActivation: Date;
    /**
     * The solar rail type
     * @type {string}
     */
    railType: string;
    /**
     * The MOTD set by the dark sector holder
     * @type {string}
     */
    defenderMOTD: string;
    /**
     * The player who deployed the solar rail
     * @type {string}
     */
    deployerName: string;
    /**
     * The clan of the player who deployed the solar rail
     * @type {string}
     */
    deployerClan: string;
    defenderRailHealReserve: any;
    healRate: number;
    damagePerMission: any;
    /**
     * The dark sector's mission
     * @type {?Mission}
     */
    mission: Mission | null;
    battlePayReserve: any;
    /**
     * The battle pay per mission offered to players
     * @type {number}
     */
    perMissionBattlePay: number;
    /**
     * The player who set the battle pay
     * @type {string}
     */
    battlePaySetBy: string;
    /**
     * The clan of the player who set the battle pay
     * @type {string}
     */
    battlePaySetByClan: string;
    /**
     * The player who changed the tax
     * @type {string}
     */
    taxChangedBy: string;
    /**
     * The clan of the player who set the tax
     * @type {string}
     */
    taxChangedByClan: string;
    /**
     * The history of the dark sector
     * @type {Array.<DarkSectorBattle>}
     */
    history: Array<DarkSectorBattle>;
}
import WorldstateObject from './WorldstateObject.js';
import Mission from './Mission.js';
import DarkSectorBattle from './DarkSectorBattle.js';