Ufo.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_UFO_H
#define OPENXCOM_UFO_H

#include "MovingTarget.h"
#include <string>
#include <yaml-cpp/yaml.h>

namespace OpenXcom
{

class RuleUfo;
class AlienMission;
class UfoTrajectory;
class SavedGame;
class Ruleset;

class Ufo : public MovingTarget
{
public:
    enum UfoStatus { FLYING, LANDED, CRASHED, DESTROYED };
private:
    RuleUfo *_rules;
    int _id, _crashId, _landId, _damage;
    std::string _direction, _altitude;
    enum UfoStatus _status;
    size_t _secondsRemaining;
    bool _inBattlescape;
    int _shotDownByCraftId;
    AlienMission *_mission;
    const UfoTrajectory *_trajectory;
    size_t _trajectoryPoint;
    bool _detected, _hyperDetected;
    int _shootingAt, _hitFrame;
    void calculateSpeed();
public:
    Ufo(RuleUfo *rules);
    ~Ufo();
    void load(const YAML::Node& node, const Ruleset &ruleset, SavedGame &game);
    YAML::Node save(bool newBattle) const;
    YAML::Node saveId() const;
    RuleUfo *getRules() const;
    int getId() const;
    void setId(int id);
    std::wstring getName(Language *lang) const;
    int getDamage() const;
    void setDamage(int damage);
    bool getDetected() const;
    void setDetected(bool detected);
    size_t getSecondsRemaining() const;
    void setSecondsRemaining(size_t seconds);
    std::string getDirection() const;
    std::string getAltitude() const;
    void setAltitude(const std::string &altitude);
    enum UfoStatus getStatus() const { return _status; }
    void setStatus(enum UfoStatus status) {_status = status; }
    bool isCrashed() const;
    bool isDestroyed() const;
    void think();
    void setInBattlescape(bool inbattle);
    bool isInBattlescape() const;
    const std::string &getAlienRace() const;
    void setShotDownByCraftId(const int id);
    int getShotDownByCraftId() const;
    int getVisibility() const;
    const std::string &getMissionType() const;
    void setMissionInfo(AlienMission *mission, const UfoTrajectory *trajectory);
    bool getHyperDetected() const;
    void setHyperDetected(bool hyperdetected);
    size_t getTrajectoryPoint() const { return _trajectoryPoint; }
    void setTrajectoryPoint(size_t np) { _trajectoryPoint = np; }
    const UfoTrajectory &getTrajectory() const { return *_trajectory; }
    AlienMission *getMission() const { return _mission; }
    void setDestination(Target *dest);
    int getShootingAt() const;
    void setShootingAt(int target);
    int getLandId() const;
    void setLandId(int id);
    int getCrashId() const;
    void setCrashId(int id);
    void setHitFrame(int frame);
    int getHitFrame();

};

}

#endif