TerrainBase::Goal Struct Reference

A movement goal. More...

#include <TerrainBase.H>

List of all members.

Public Types
enum	Target { LOCATION, OBJ }
	target location or an object to reach? More...
enum	Mode { VICINITY, TOUCH, ATTACK }
	reach vicinity, touch object, attack object? More...
Public Member Functions
	Goal (Target t, Mode m)
	Goal (const Object *o, Mode m)
	Goal (const Loc &l, Mode m)
	Goal (const Goal &other)
Public Attributes
enum TerrainBase::Goal::Target	target
enum TerrainBase::Goal::Mode	mode
Loc	loc
	The goal location (if target==LOCATION)
const Object *	obj
	The goal object (if target==OBJ).
sint4	distance
	The distance from the target that is 'close enough' (if mode==VICINITY)

---

Detailed Description

A movement goal.

Definition at line 113 of file TerrainBase.H.

---

Member Enumeration Documentation

enum TerrainBase::Goal::Mode

reach vicinity, touch object, attack object?

Enumerator:

VICINITY
TOUCH
ATTACK

Definition at line 119 of file TerrainBase.H.

enum TerrainBase::Goal::Target

target location or an object to reach?

Enumerator:

LOCATION
OBJ

Definition at line 116 of file TerrainBase.H.

---

Constructor & Destructor Documentation

TerrainBase::Goal::Goal	(	Target	t,
		Mode	m
	)		[inline]

Definition at line 133 of file TerrainBase.H.

TerrainBase::Goal::Goal	(	const Object *	o,
		Mode	m
	)		[inline]

Definition at line 134 of file TerrainBase.H.

TerrainBase::Goal::Goal	(	const Loc &	l,
		Mode	m
	)		[inline]

Definition at line 135 of file TerrainBase.H.

TerrainBase::Goal::Goal

(

const Goal &

other

)

[inline]

Definition at line 137 of file TerrainBase.H.

---

Member Data Documentation

sint4 TerrainBase::Goal::distance

The distance from the target that is 'close enough' (if mode==VICINITY)

Definition at line 131 of file TerrainBase.H.

Referenced by PursueAttack::act(), BaseDefense::act(), Simul::DEFINE_TASK(), SimplePFAdapter::find_path(), SimpleTerrain::SimpleGlobalPF::find_path(), SimpleTerrain::ST_ForceField::is_at_goal(), SimpleTerrain::ST_Terrain::is_at_goal(), ForceFieldPE::is_at_goal(), and FFLocPath::is_at_goal().

Loc TerrainBase::Goal::loc

The goal location (if target==LOCATION)

Definition at line 122 of file TerrainBase.H.

Referenced by BSimul::DEFINE_BTASK(), Simul::DEFINE_TASK(), TRTerrain::TR_Terrain::find_path(), SimpleTerrain::ST_ForceField::find_path(), SimpleTerrain::ST_Terrain::find_path(), SimplePFAdapter::find_path(), SimpleTerrain::SimpleGlobalPF::find_path(), FFLocPath::find_path(), GfxModule::GUI_broadcast(), SimpleTerrain::ST_ForceField::is_at_goal(), SimpleTerrain::ST_Terrain::is_at_goal(), ForceFieldPE::is_at_goal(), FFLocPath::is_at_goal(), TerrainBase::Obj2LocTask::Obj2LocTask(), and SimpleTerrain::ST_Task::ST_Task().

enum TerrainBase::Goal::Mode TerrainBase::Goal::mode

Referenced by PursueAttack::act(), SimpleTerrain::ST_ForceField::find_path(), SimpleTerrain::ST_Terrain::find_path(), SimplePFAdapter::find_path(), SimpleTerrain::SimpleGlobalPF::find_path(), FFLocPath::find_path(), SimpleTerrain::ST_ForceField::is_at_goal(), SimpleTerrain::ST_Terrain::is_at_goal(), ForceFieldPE::is_at_goal(), and FFLocPath::is_at_goal().

const Object* TerrainBase::Goal::obj

The goal object (if target==OBJ).

It's the implementation's responsibility to track remove_object() calls and handle cases of a goal object dying or vanishing in the FOW (and this pointer becoming invalid).

Definition at line 128 of file TerrainBase.H.

Referenced by PursueAttack::act(), BaseDefense::act(), TerrainBasicImp< TaskWrapper >::add_task(), ForceFieldPE::calculate_move(), Simul::DEFINE_TASK(), TRTerrain::TR_Terrain::find_path(), SimpleTerrain::ST_ForceField::find_path(), SimpleTerrain::ST_Terrain::find_path(), SimplePFAdapter::find_path(), SimpleTerrain::SimpleGlobalPF::find_path(), FFLocPath::find_path(), BSimul::BuildTasksAI::handle_event(), SimpleTerrain::ST_ForceField::is_at_goal(), SimpleTerrain::ST_Terrain::is_at_goal(), ForceFieldPE::is_at_goal(), FFLocPath::is_at_goal(), TerrainBase::Obj2ObjTask::Obj2ObjTask(), and SimpleTerrain::ST_Task::ST_Task().

enum TerrainBase::Goal::Target TerrainBase::Goal::target

Referenced by TerrainBasicImp< TaskWrapper >::add_task(), ForceFieldPE::calculate_move(), TRTerrain::TR_Terrain::find_path(), SimpleTerrain::ST_ForceField::find_path(), SimpleTerrain::ST_Terrain::find_path(), SimplePFAdapter::find_path(), SimpleTerrain::SimpleGlobalPF::find_path(), FFLocPath::find_path(), SimpleTerrain::ST_ForceField::is_at_goal(), SimpleTerrain::ST_Terrain::is_at_goal(), ForceFieldPE::is_at_goal(), FFLocPath::is_at_goal(), and SimpleTerrain::ST_Task::ST_Task().

---

The documentation for this struct was generated from the following file:

• TerrainBase.H