RuleItem.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_RULEITEM_H
#define OPENXCOM_RULEITEM_H

#include <string>
#include <vector>
#include <yaml-cpp/yaml.h>

namespace OpenXcom
{

enum ItemDamageType { DT_NONE, DT_AP, DT_IN, DT_HE, DT_LASER, DT_PLASMA, DT_STUN, DT_MELEE, DT_ACID, DT_SMOKE };
enum BattleType { BT_NONE, BT_FIREARM, BT_AMMO, BT_MELEE, BT_GRENADE, BT_PROXIMITYGRENADE, BT_MEDIKIT, BT_SCANNER, BT_MINDPROBE, BT_PSIAMP, BT_FLARE, BT_CORPSE };

class SurfaceSet;
class Surface;

class RuleItem
{
private:
    std::string _type, _name; // two types of objects can have the same name
    std::vector<std::string> _requires;
    double _size;
    int _costBuy, _costSell, _transferTime, _weight;
    int _bigSprite, _floorSprite, _handSprite, _bulletSprite;
    int _fireSound, _hitSound, _hitAnimation;
    int _power;
    std::vector<std::string> _compatibleAmmo;
    ItemDamageType _damageType;
    int _accuracyAuto, _accuracySnap, _accuracyAimed, _tuAuto, _tuSnap, _tuAimed;
    int _clipSize, _accuracyMelee, _tuMelee;
    BattleType _battleType;
    bool _twoHanded, _waypoint, _fixedWeapon;
    int _invWidth, _invHeight;
    int _painKiller, _heal, _stimulant;
    int _woundRecovery, _healthRecovery, _stunRecovery, _energyRecovery;
    int _tuUse;
    int _recoveryPoints;
    int _armor;
    int _turretType;
    bool _recover, _liveAlien;
    int _blastRadius, _attraction;
    bool _flatRate, _arcingShot;
    int _listOrder, _maxRange, _aimRange, _snapRange, _autoRange, _minRange, _dropoff, _bulletSpeed, _explosionSpeed, _autoShots, _shotgunPellets;
    std::string _zombieUnit;
    bool _strengthApplied, _skillApplied, _LOSRequired;
    int _meleeSound, _meleePower, _meleeAnimation, _meleeHitSound;
public:
    RuleItem(const std::string &type);
    ~RuleItem();
    void load(const YAML::Node& node, int modIndex, int listIndex);
    std::string getType() const;
    std::string getName() const;
    const std::vector<std::string> &getRequirements() const;
    double getSize() const;
    int getBuyCost() const;
    int getSellCost() const;
    int getTransferTime() const;
    int getWeight() const;
    int getBigSprite() const;
    int getFloorSprite() const;
    int getHandSprite() const;
    bool isTwoHanded() const;
    bool isWaypoint() const;
    bool isFixed() const;
    int getBulletSprite() const;
    int getFireSound() const;
    int getHitSound() const;
    int getHitAnimation() const;
    int getPower() const;
    int getAccuracySnap() const;
    int getAccuracyAuto() const;
    int getAccuracyAimed() const;
    int getAccuracyMelee() const;
    int getTUSnap() const;
    int getTUAuto() const;
    int getTUAimed() const;
    int getTUMelee() const;
    std::vector<std::string> *getCompatibleAmmo();
    ItemDamageType getDamageType() const;
    BattleType getBattleType() const;
    int getInventoryWidth() const;
    int getInventoryHeight() const;
    int getClipSize() const;
    void drawHandSprite(SurfaceSet *texture, Surface *surface) const;
    int getHealQuantity () const;
    int getPainKillerQuantity () const;
    int getStimulantQuantity () const;
    int getWoundRecovery () const;
    int getHealthRecovery () const;
    int getEnergyRecovery () const;
    int getStunRecovery () const;
    int getTUUse() const;
    int getExplosionRadius() const;
    int getRecoveryPoints() const;
    int getArmor() const;
    bool isRecoverable() const;
    int getTurretType() const;
    bool getAlien() const;
    bool getFlatRate() const;
    bool getArcingShot() const;
    int getAttraction() const;
    int getListOrder() const;
    int getBulletSpeed() const;
    int getExplosionSpeed() const;
    int getAutoShots() const;
    bool isRifle() const;
    bool isPistol() const;
    int getMaxRange() const;
    int getAimRange() const;
    int getSnapRange() const;
    int getAutoRange() const;
    int getMinRange() const;
    int getDropoff() const;
    int getShotgunPellets() const;
    std::string getZombieUnit() const;
    bool isStrengthApplied() const;
    bool isSkillApplied() const;
    int getMeleeAttackSound() const;
    int getMeleeHitSound() const;
    int getMeleePower() const;
    int getMeleeAnimation() const;
    bool isLOSRequired() const;
};

}

#endif