AlienDeployment.h

#pragma once
/*
 * Copyright 2010-2016 OpenXcom Developers.
 *
 * This file is part of OpenXcom.
 *
 * OpenXcom is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * OpenXcom is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenXcom.  If not, see <http://www.gnu.org/licenses/>.
 */
#include <vector>
#include <string>
#include <yaml-cpp/yaml.h>
#include "Mod.h"
#include "../Savegame/WeightedOptions.h"

namespace OpenXcom
{

class RuleTerrain;
class Mod;

struct ItemSet
{
    std::vector<std::string> items;
};

struct DeploymentData
{
    int alienRank;
    int lowQty, highQty, dQty, extraQty;
    int percentageOutsideUfo;
    std::vector<ItemSet> itemSets;
};
struct BriefingData
{
    int palette, textOffset;
    std::string title, desc, music, background, cutscene;
    bool showCraft, showTarget;
    BriefingData() : palette(0), textOffset(0), music("GMDEFEND"), background("BACK16.SCR"), showCraft(true), showTarget(true) { /*Empty by Design*/ };
};
enum ChronoTrigger { FORCE_LOSE, FORCE_ABORT, FORCE_WIN };
class AlienDeployment
{
private:
    std::string _type;
    std::vector<DeploymentData> _data;
    int _width, _length, _height, _civilians;
    std::vector<std::string> _terrains, _music;
    int _shade;
    std::string _nextStage, _race, _script;
    bool _finalDestination, _isAlienBase;
    std::string _winCutscene, _loseCutscene;
    std::string _alert, _alertBackground;
    BriefingData _briefingData;
    std::string _markerName, _objectivePopup, _objectiveCompleteText, _objectiveFailedText;
    WeightedOptions _genMission;
    int _markerIcon, _durationMin, _durationMax, _minDepth, _maxDepth, _minSiteDepth, _maxSiteDepth, _genMissionFrequency;
    int _objectiveType, _objectivesRequired, _objectiveCompleteScore, _objectiveFailedScore, _despawnPenalty, _points, _turnLimit, _cheatTurn;
    ChronoTrigger _chronoTrigger;
public:
    AlienDeployment(const std::string &type);
    ~AlienDeployment();
    void load(const YAML::Node& node, Mod *mod);
    std::string getType() const;
    std::vector<DeploymentData>* getDeploymentData();
    void getDimensions(int *width, int *length, int *height) const;
    int getCivilians() const;
    std::vector<std::string> getTerrains() const;
    int getShade() const;
    std::string getNextStage() const;
    std::string getRace() const;
    std::string getScript() const;
    bool isFinalDestination() const;
    std::string getWinCutscene() const;
    std::string getLoseCutscene() const;
    std::string getAlertMessage() const;
    std::string getAlertBackground() const;
    BriefingData getBriefingData() const;
    std::string getMarkerName() const;
    int getMarkerIcon() const;
    int getDurationMin() const;
    int getDurationMax() const;
    std::vector<std::string> &getMusic();
    int getMinDepth() const;
    int getMaxDepth() const;
    int getMinSiteDepth() const;
    int getMaxSiteDepth() const;
    int getObjectiveType() const;
    int getObjectivesRequired() const;
    std::string getObjectivePopup() const;
    bool getObjectiveCompleteInfo(std::string &text, int &score) const;
    bool getObjectiveFailedInfo(std::string &text, int &score) const;
    int getDespawnPenalty() const;
    int getPoints() const;
    int getTurnLimit() const;
    ChronoTrigger getChronoTrigger() const;
    int getCheatTurn() const;
    bool isAlienBase() const;

    std::string getGenMissionType() const;

    int getGenMissionFrequency() const;

};

}