COrder_Resource Class Reference

#include <action_resource.h>

Inheritance diagram for COrder_Resource:

Public Member Functions
	COrder_Resource (CUnit &harvester)
virtual COrder_Resource *	Clone () const
int	GetCurrentResource () const
Public Member Functions inherited from COrder
	COrder (int action)
virtual void	Cancel (CUnit &unit)
virtual void	UpdateUnitVariables (CUnit &unit) const
bool	HasGoal () const
CUnit *	GetGoal () const
bool	ParseGenericData (lua_State *l, int &j, const char *value)
virtual	~COrder ()
	Hash calculated to find sync failures. More...
virtual void	OnAnimationAttack (CUnit &unit)
virtual void	FillSeenValues (CUnit &unit) const
virtual void	AiUnitKilled (CUnit &unit)
void	SetGoal (CUnit *const new_goal)
void	ClearGoal ()

Friends
COrder *	COrder::NewActionResource (CUnit &harvester, const Vec2i &pos)
COrder *	COrder::NewActionResource (CUnit &harvester, CUnit &mine)
COrder *	COrder::NewActionReturnGoods (CUnit &harvester, CUnit *depot)

action_resource.cpp - The generic resource action.
	~COrder_Resource ()
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 PixelPos	Show (const CViewport &vp, const PixelPos &lastScreenPos) const
virtual void	UpdatePathFinderData (PathFinderInput &input)
virtual bool	OnAiHitUnit (CUnit &unit, CUnit *attacker, int)
Vec2i	GetHarvestLocation () const
bool	IsGatheringStarted () const
bool	IsGatheringFinished () const
bool	IsGatheringWaiting () const
virtual const Vec2i	GetGoalPos () const

Additional Inherited Members
Static Public Member Functions inherited from COrder
static COrder *	NewActionAttack (const CUnit &attacker, CUnit &target)
static COrder *	NewActionAttack (const CUnit &attacker, const Vec2i &dest)
static COrder *	NewActionAttackGround (const CUnit &attacker, const Vec2i &dest)
static COrder *	NewActionBoard (CUnit &unit)
static COrder *	NewActionBuild (const CUnit &builder, const Vec2i &pos, CUnitType &building)
static COrder *	NewActionBuilt (CUnit &builder, CUnit &unit)
static COrder *	NewActionDefend (CUnit &dest)
static COrder *	NewActionDie ()
static COrder *	NewActionExplore (const CUnit &unit)
static COrder *	NewActionFollow (CUnit &dest)
static COrder *	NewActionMove (const Vec2i &pos)
static COrder *	NewActionPatrol (const Vec2i &currentPos, const Vec2i &dest)
static COrder *	NewActionRepair (CUnit &unit, CUnit &target)
static COrder *	NewActionRepair (const Vec2i &pos)
static COrder *	NewActionResearch (CUnit &unit, CUpgrade &upgrade)
static COrder *	NewActionResource (CUnit &harvester, const Vec2i &pos)
static COrder *	NewActionResource (CUnit &harvester, CUnit &mine)
static COrder *	NewActionReturnGoods (CUnit &harvester, CUnit *depot)
static COrder *	NewActionSpellCast (const SpellType &spell, const Vec2i &pos, CUnit *target, bool isAutocast=false)
static COrder *	NewActionStandGround ()
static COrder *	NewActionStill ()
static COrder *	NewActionTrain (CUnit &trainer, CUnitType &type)
static COrder *	NewActionTransformInto (CUnitType &type)
static COrder *	NewActionUpgradeTo (CUnit &unit, CUnitType &type, bool instant=false)
static COrder *	NewActionUnload (const Vec2i &pos, CUnit *what)
Public Attributes inherited from COrder
const unsigned char	Action
bool	Finished
	global action More...
bool	Instant
	true when order is finish More...
Protected Member Functions inherited from COrder
void	UpdatePathFinderData_NotCalled (PathFinderInput &input)

Constructor & Destructor Documentation

COrder_Resource()

COrder_Resource::COrder_Resource ( CUnit &  harvester )

inline

~COrder_Resource()

COrder_Resource::~COrder_Resource

(

)

Member Function Documentation

Clone()

virtual COrder_Resource* COrder_Resource::Clone ( ) const

inlinevirtual

Implements COrder.

Execute()

void COrder_Resource::Execute ( CUnit &  unit )

virtual

Control the unit action: getting a resource.

This the generic function for oil, gold, ...

Parameters

unit	Pointer to unit.

Implements COrder.

GetCurrentResource()

int COrder_Resource::GetCurrentResource ( ) const

inline

GetGoalPos()

const Vec2i COrder_Resource::GetGoalPos ( ) const

virtual

Get goal position

Reimplemented from COrder.

GetHarvestLocation()

Vec2i COrder_Resource::GetHarvestLocation

(

)

const

IsGatheringFinished()

bool COrder_Resource::IsGatheringFinished

(

)

const

IsGatheringStarted()

bool COrder_Resource::IsGatheringStarted

(

)

const

IsGatheringWaiting()

bool COrder_Resource::IsGatheringWaiting

(

)

const

IsValid()

bool COrder_Resource::IsValid ( ) const

virtual

Implements COrder.

OnAiHitUnit()

bool COrder_Resource::OnAiHitUnit ( CUnit &  unit, CUnit *  attacker, int    )

virtual

Reimplemented from COrder.

ParseSpecificData()

bool COrder_Resource::ParseSpecificData ( lua_State *  l, int &  j, const char *  value, const CUnit &  unit  )

virtual

Implements COrder.

Save()

void COrder_Resource::Save ( CFile &  file, const CUnit &  unit  ) const

virtual

Implements COrder.

Show()

PixelPos COrder_Resource::Show ( const CViewport &  vp, const PixelPos &  lastScreenPos  ) const

virtual

Implements COrder.

UpdatePathFinderData()

void COrder_Resource::UpdatePathFinderData ( PathFinderInput &  input )

virtual

Implements COrder.

Friends And Related Function Documentation

COrder::NewActionResource [1/2]

COrder* COrder::NewActionResource ( CUnit &  harvester, const Vec2i &  pos  )

friend

COrder::NewActionResource [2/2]

COrder* COrder::NewActionResource ( CUnit &  harvester, CUnit &  mine  )

friend

COrder::NewActionReturnGoods

COrder* COrder::NewActionReturnGoods ( CUnit &  harvester, CUnit *  depot  )

friend

Member Data Documentation

Mine

CUnitPtr COrder_Resource::Mine

position for terrain resource.

Pos

Vec2i COrder_Resource::Pos

---

The documentation for this class was generated from the following files:

• src/include/action/action_resource.h
• src/action/action_resource.cpp