CvArmyAI.h

/*	-------------------------------------------------------------------------------------------------------
	© 1991-2012 Take-Two Interactive Software and its subsidiaries.  Developed by Firaxis Games.  
	Sid Meier's Civilization V, Civ, Civilization, 2K Games, Firaxis Games, Take-Two Interactive Software 
	and their respective logos are all trademarks of Take-Two interactive Software, Inc.  
	All other marks and trademarks are the property of their respective owners.  
	All rights reserved. 
	------------------------------------------------------------------------------------------------------- */
#pragma once

// CvArmyAI.h

#ifndef CIV5_ARMYAI_H
#define CIV5_ARMYAI_H

class CvPlot;
class CvArea;
class CvAStarNode;
class CvUnit;
class CvMultiUnitFormationInfo;
class CvAIOperation;

#define SAFE_ESTIMATE_NUM_MULTIUNITFORMATION_ENTRIES 20

#define ARMYSLOT_UNKNOWN_TURN_AT_CHECKPOINT -1
#define ARMYSLOT_NOT_INCLUDING_IN_OPERATION -2

#define ARMY_NO_UNIT -1

class CvArmyFormationSlot
{
public:
	CvArmyFormationSlot ()
	{
		m_iUnitID = ARMY_NO_UNIT;
		m_iEstimatedTurnAtCheckpoint = ARMYSLOT_UNKNOWN_TURN_AT_CHECKPOINT;
		m_bStartedOnOperation = false;
	};

	int GetUnitID() {return m_iUnitID;};
	void SetUnitID(int iValue) {m_iUnitID = iValue;};
	int GetTurnAtCheckpoint() {return m_iEstimatedTurnAtCheckpoint;};
	void SetTurnAtCheckpoint(int iValue) {m_iEstimatedTurnAtCheckpoint = iValue;};
	bool HasStartedOnOperation() {return m_bStartedOnOperation;};
	void SetStartedOnOperation(bool bValue) {m_bStartedOnOperation = bValue;};

	int m_iUnitID;
	int m_iEstimatedTurnAtCheckpoint;
	int m_bStartedOnOperation;
};

enum ArmyAIState
{
	NO_ARMYAISTATE = -1,
	ARMYAISTATE_WAITING_FOR_UNITS_TO_REINFORCE,
	ARMYAISTATE_WAITING_FOR_UNITS_TO_CATCH_UP,
	ARMYAISTATE_MOVING_TO_DESTINATION,
	ARMYAISTATE_AT_DESTINATION,
};

//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
//  CLASS:      CvArmyAI
//!  \brief		One army in an operational maneuver
//
//!  Key Attributes:
//!  - Manages the turn-by-turn movement of an army
//!  - Created and owned by one AI operation
//!  - Uses step path finder to find muster points before it has units
//!  - Uses main path finder to plot route once it has units
//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
class CvArmyAI
{

public:

	CvArmyAI();
	virtual ~CvArmyAI();

	// Initialization/destruction routines
	void Init(int iID, PlayerTypes eOwner, int iOperationID);
	void Uninit();
	void Reset(int iID = 0, PlayerTypes eOwner = NO_PLAYER, int iOperationID = -1, bool bConstructorCall = false);
	void Kill();

	// for serialization - must be lowerCamelCase due to FFreeListTrashArray
	virtual void read(FDataStream& kStream);
	virtual void write(FDataStream& kStream) const;

	// Accessors
	//		Next two routines must be lowerCamelCase due to FFreeListTrashArray
	int GetID();
	void SetID(int iID);

	TeamTypes GetTeam() const;

	ArmyAIState GetArmyAIState() const;
	void SetArmyAIState(ArmyAIState eNewArmyAIState);

	int GetMovementRate();
	CvPlot *GetCenterOfMass();
	int GetFurthestUnitDistance(CvPlot *pPlot);

	inline PlayerTypes GetOwner() const
	{
		return m_eOwner;
	}

	inline int GetOperationID() const
	{
		return m_iOperationID;
	}

	// Formation accessors
	int GetFormationIndex() const;
	void SetFormationIndex(int iFormationIndex);
	int GetNumFormationEntries() const;
	int GetNumSlotsFilled() const;
	void SetEstimatedTurn(int iSlotID, int iTurns);
	CvArmyFormationSlot *GetFormationSlot(int iSlotID) {return &m_FormationEntries[iSlotID];};
	int GetTurnAtNextCheckpoint() const;
	void UpdateCheckpointTurns();
	int GetUnitsOfType(MultiunitPositionTypes ePosition) const;
	bool IsAllOceanGoing();

	//Army strength accessors
	int GetTotalPower();

	// Position accessors
	int GetX() const;
	int GetY() const;
	void SetX(int iX);
	void SetY(int iY);
	void SetXY(int iX, int iY);
	CvPlot* Plot() const;
	int GetArea() const;
	DomainTypes GetDomainType() const;
	void SetDomainType(DomainTypes domainType);
	bool AreAllInWater();

	// Goal accessors
	void SetGoalPlot(CvPlot* pGoalPlot);
	CvPlot* GetGoalPlot() const;
	int GetGoalX() const;
	int GetGoalY() const;
	void SetGoalXY(int iX, int iY);

	// Unit handling
	void AddUnit(int iUnitId, int iSlotNum);
	bool RemoveUnit(int iUnitId);
	bool CanTacticalAIInterruptUnit(int iUnitId) const;
	int GetFirstUnitID();
	int GetNextUnitID();
	UnitHandle GetFirstUnit();
    UnitHandle GetNextUnit();
	UnitHandle GetFirstUnitInDomain(DomainTypes eDomain);

	// Per turn processing
	void DoTurn();
	bool DoDelayedDeath();

protected:
	int m_iID;
	PlayerTypes m_eOwner;
	int m_iOperationID;
	int m_iCurrentX;
	int m_iCurrentY;
	int m_iGoalX;
	int m_iGoalY;
	int m_eDomainType; // DomainTypes
	int m_iFormationIndex;
	int m_eAIState; // ArmyAIState
	FStaticVector<CvArmyFormationSlot, SAFE_ESTIMATE_NUM_MULTIUNITFORMATION_ENTRIES, true, c_eCiv5GameplayDLL, 0> m_FormationEntries;
	FStaticVector<CvArmyFormationSlot, SAFE_ESTIMATE_NUM_MULTIUNITFORMATION_ENTRIES, true, c_eCiv5GameplayDLL, 0>::iterator m_CurUnitIter;
};

FDataStream & operator<<(FDataStream &, const CvArmyAI &);
FDataStream & operator>>(FDataStream &, CvArmyAI &);

FDataStream & operator<<(FDataStream &, const CvArmyFormationSlot &);
FDataStream & operator>>(FDataStream &, CvArmyFormationSlot &);

#endif