Soldier.h

/*
 * Copyright 2010-2014 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/>.
 */
#ifndef OPENXCOM_SOLDIER_H
#define OPENXCOM_SOLDIER_H

#include <string>
#include <yaml-cpp/yaml.h>
#include "../Ruleset/Unit.h"
#include "../Ruleset/StatString.h"
     
namespace OpenXcom
{

enum SoldierRank { RANK_ROOKIE, RANK_SQUADDIE, RANK_SERGEANT, RANK_CAPTAIN, RANK_COLONEL, RANK_COMMANDER};
enum SoldierGender { GENDER_MALE, GENDER_FEMALE };
enum SoldierLook { LOOK_BLONDE, LOOK_BROWNHAIR, LOOK_ORIENTAL, LOOK_AFRICAN };

class Craft;
class SoldierNamePool;
class Ruleset;
class RuleSoldier;
class Armor;
class Language;
class EquipmentLayoutItem;
class SoldierDeath;
class SavedGame;

class Soldier
{
private:
    std::wstring _name;
    int _id, _improvement;
    RuleSoldier *_rules;
    UnitStats _initialStats, _currentStats;
    SoldierRank _rank;
    Craft *_craft;
    SoldierGender _gender;
    SoldierLook _look;
    int _missions, _kills, _recovery;
    bool _recentlyPromoted, _psiTraining;
    Armor *_armor;
    std::vector<EquipmentLayoutItem*> _equipmentLayout;
    SoldierDeath *_death;
    std::wstring _statString;
public:
    Soldier(RuleSoldier *rules, Armor *armor, const std::vector<SoldierNamePool*> *names = 0, int id = 0);
    ~Soldier();
    void load(const YAML::Node& node, const Ruleset *rule, SavedGame *save);
    YAML::Node save() const;
    std::wstring getName(bool statstring = false, unsigned int maxLength = 20) const;
    void setName(const std::wstring &name);
    Craft *getCraft() const;
    void setCraft(Craft *craft);
    std::wstring getCraftString(Language *lang) const;
    std::string getRankString() const;
    int getRankSprite() const;
    SoldierRank getRank() const;
    void promoteRank();
    int getMissions() const;
    int getKills() const;
    SoldierGender getGender() const;
    SoldierLook getLook() const;
    RuleSoldier *getRules() const;
    int getId() const;
    void addMissionCount();
    void addKillCount(int count);
    UnitStats *getInitStats();
    UnitStats *getCurrentStats();
    bool isPromoted();
    Armor *getArmor() const;
    void setArmor(Armor *armor);
    int getWoundRecovery() const;
    void setWoundRecovery(int recovery);
    void heal();
    std::vector<EquipmentLayoutItem*> *getEquipmentLayout();
    void trainPsi();
    void trainPsi1Day();
    bool isInPsiTraining();
    void setPsiTraining();
    int getImprovement();
    SoldierDeath *getDeath() const;
    void die(SoldierDeath *death);
    void calcStatString(const std::vector<StatString *> &statStrings, bool psiStrengthEval);
};

}

#endif