action_attack.h

Go to the documentation of this file.

//       _________ __                 __
//      /   _____//  |_____________ _/  |______     ____  __ __  ______
//      \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
//      /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ |
//     /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
//             \/                  \/          \//_____/            \/
//  ______________________                           ______________________
//                        T H E   W A R   B E G I N S
//         Stratagus - A free fantasy real time strategy game engine
//
//
//      (c) Copyright 1998-2012 by Lutz Sammer and Jimmy Salmon
//
//      This program 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; only version 2 of the License.
//
//      This program 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 this program; if not, write to the Free Software
//      Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.
//
 
#ifndef __ACTION_ATTACK_H__
#define __ACTION_ATTACK_H__
 
#include "actions.h"
 
 
class COrder_Attack : public COrder
{
        friend COrder *COrder::NewActionAttack(const CUnit &attacker, CUnit &target);
        friend COrder *COrder::NewActionAttack(const CUnit &attacker, const Vec2i &dest);
        friend COrder *COrder::NewActionAttackGround(const CUnit &attacker, const Vec2i &dest);
public:
        explicit COrder_Attack(bool ground) : COrder(ground ? UnitActionAttackGround : UnitActionAttack),
                State(0), MinRange(0), Range(0), SkirmishRange(0), offeredTarget(NULL), goalPos(-1, -1), attackMovePos(-1, -1), Sleep(0) {}
 
        virtual COrder_Attack *Clone() const { return new COrder_Attack(*this); }
 
        virtual bool IsValid() const;
        virtual void Save(CFile &file, const CUnit &unit) const;
        virtual bool ParseSpecificData(lua_State *l, int &j, const char *value, const CUnit &unit);
 
        virtual void Execute(CUnit &unit);
        virtual void OnAnimationAttack(CUnit &unit);
        virtual PixelPos Show(const CViewport &vp, const PixelPos &lastScreenPos) const;
        virtual void UpdatePathFinderData(PathFinderInput &input);
        virtual bool OnAiHitUnit(CUnit &unit, CUnit *attacker, int /*damage*/);
 
        virtual const Vec2i GetGoalPos() const { return goalPos; }
        bool IsWeakTargetSelected() const;
        bool IsAutoTargeting() const;
        bool IsMovingToAttackPos() const;
        bool IsAttackGroundOrWall() const;
        bool IsTargetTooClose(const CUnit &unit) const;
        CUnit *const BestTarget(const CUnit &unit, CUnit *const target1, CUnit *const target2) const;
        void OfferNewTarget(const CUnit &unit, CUnit *const target);
 
private:
        bool CheckIfGoalValid(CUnit &unit);
        void TurnToTarget(CUnit &unit, const CUnit *target);
        void SetAutoTarget(CUnit &unit, CUnit *target);
        bool EndActionAttack(CUnit &unit, const bool canBeFinished);
        void MoveToBetterPos(CUnit &unit);
        bool AutoSelectTarget(CUnit &unit);
        bool CheckForTargetInRange(CUnit &unit);
        void MoveToAttackPos(CUnit &unit, const int pfReturn);
        void MoveToTarget(CUnit &unit);
        void AttackTarget(CUnit &unit);
 
private:
        int State;
        int MinRange;
        int Range;
        int SkirmishRange;
        CUnitPtr offeredTarget; // Stores pointer to target offered from outside (f.e. by HitUnit_AttackBack() event). 
        Vec2i goalPos;           // Current goal position
        Vec2i attackMovePos; // If attack-move was ordered
        unsigned char Sleep;
};
 
#endif // !__ACTION_ATTACK_H__