warframe-worldstate-parser/lib/Mission.js

An Open parser for Warframe's Worldstate in Javascript

'use strict';

/**
 * Represents an in-game mission
 */
class Mission {
  /**
   * @param   {Object}             data            The mission data
   * @param   {Object}             deps            The dependencies object
   * @param   {MarkdownSettings}   deps.mdConfig   The markdown settings
   * @param   {Translator}         deps.translator The string translator
   * @param   {Reward}             deps.Reward     The Reward parser
   * @param   {string}             deps.locale     Locale to use for translations
   */
  constructor(data, {
    mdConfig, translator, Reward, locale,
  }) {
    const deps = {
      mdConfig, translator, Reward, locale,
    };

    /**
     * The markdown settings
     * @type {MarkdownSettings}
     * @private
     */
    this.mdConfig = mdConfig;
    Object.defineProperty(this, 'mdConfig', { enumerable: false, configurable: false });

    /**
     * The mission's description
     * @type {?string}
     */
    this.description = translator.languageString(data.descText, locale);

    /**
     * The node where the mission takes place
     * @type {string}
     */
    this.node = translator.node(data.location, locale);

    /**
     * The mission's type
     * @type {string}
     */
    this.type = translator.missionType(data.missionType, locale);

    /**
     * The factions that the players must fight in the mission
     * @type {string}
     */
    this.faction = translator.faction(data.faction, locale);

    /**
     * The mission's reward
     * @type {?Reward}
     */
    this.reward = data.missionReward
      ? new Reward(data.missionReward, deps)
      : undefined;

    /**
     * The minimum level of the enemies in the mission
     * @type {number}
     */
    this.minEnemyLevel = data.minEnemyLevel;

    /**
     * The maximum level of the enemies in the mission
     * @type {number}
     */
    this.maxEnemyLevel = data.maxEnemyLevel;

    /**
     * The number of waves that the players need to complete (undefined if not applicable)
     * @type {?number}
     */
    this.maxWaveNum = data.maxWaveNum;

    /**
     * The Mission's nightmare boolean
     * @type {boolean}
     */
    this.nightmare = data.nightmare || false;

    /**
     * The Mission's archwing requirement
     * @type {boolean}
     */
    this.archwingRequired = data.archwingRequired || false;

    /**
     * The Mission's sharkwing requirement
     * @type {boolean}
     */
    this.isSharkwing = data.isSharkwingMission || false;

    /**
     * Override for the map on this mission
     * @type {string}
     */
    this.levelOverride = translator.languageString(data.levelOverride, locale);

    /**
     * Enemy specification for the mission
     * @type {String}
     */
    this.enemySpec = translator.languageString(data.enemySpec, locale);

    /**
     * Array of strings denoting extra spawners for a mission
     * @type {string[]}
     */
    this.advancedSpawners = (data.advancedSpawners || [])
      .map(spawner => translator.languageString(spawner, locale));

    /**
     * Items required to enter the mission
     * @type {string[]}
     */
    this.requiredItems = (data.requiredItems || [])
      .map(reqItem => translator.languageString(reqItem, locale));

    /**
     * Whether or not the required items are consumed
     * @type {boolean}
     */
    this.consumeRequiredItems = data.consumeRequiredItems;

    /**
     * Target for the mission
     * @type {string}
     */
    this.target = translator.languageString(data.vipAgent, locale);

    /**
     * Whether or not leaders are always allowed
     * @type {boolean}
     */
    this.leadersAlwaysAllowed = data.leadersAlwaysAllowed;

    /**
     * A tag for the event that this corresponds to
     * @type {string}
     */
    this.goalTag = data.goalTag;

    /**
     * Affectors for this mission
     * @type {string[]}
     */
    this.levelAuras = (data.levelAuras || []).map(aura => translator.languageString(aura, locale));
  }

  /**
   * The Mission's string representation
   * @returns {string}
   */
  toString() {
    const lines = [
      this.reward.toString(),
    ];

    lines.push(`${this.faction} (${this.type})`);
    lines.push(this.node);
    lines.push(`level ${this.minEnemyLevel} - ${this.maxEnemyLevel}`);

    return lines.join(this.mdConfig.lineEnd);
  }
}

module.exports = Mission;