CCmpSenses Class Reference

Senses Looks, listens, smells for GEs with certain ObjTypes (see CCmpObjType). More...

#include <cmpSenses.h>

Inheritance diagram for CCmpSenses:

List of all members.

Public Types
enum	eFlags { kEnemyVisible = 0, kEnemyAware }
	Level of awareness. More...
Public Member Functions
Create methods
	CCmpSenses (CGameEntity *pGE)
	Create with default values.
	~CCmpSenses ()
Virtual methods
virtual int	set (const EDIT_DATA &editData)
	Set a value.
virtual int	get (EDIT_DATA &editData) const
	Get a value.
virtual int	act (const ACTION_DATA &actData)
	Preform an action.
virtual void	update ()
	Update this Cmp for a single frame.
Sight methods
bool	inFOV (CVector3D &vUnit, unit halfFOVRad)
	In the GE's field-of-view?
bool	inLOS (CGameEntity *pTarget)
	In the GE's line-of-sight?
Memory methods
void	memory_update (const OBJTYPE_DATA *pData, CVector3D &vPos, CVector3D &vUnit, unit dist, bool bInFOV)
	Add/update a memory record.
void	memory_prune (unit timeTotal)
	Prune old records out of current list.
bool	memory_remove (long id)
	Remove a memory record.
SENSEMEMORY_DATA *	memory_closest ()
	Who's closest?
Info methods
bool	isAware () const
	Returns: true if we are aware of an enemy
bool	isVisible () const
	Returns: true if we can see an enemy

---

Detailed Description

Senses Looks, listens, smells for GEs with certain ObjTypes (see CCmpObjType).

(c) 2007-2008 oP group Germany GbR. All rights reserved.
This source code is provided "as is" with no warranty and must not be distributed without written permission.

Author:

Doug Poston

Version:

1.3

Date:

12/28/2007

---

Member Enumeration Documentation

enum CCmpSenses::eFlags

Level of awareness.

Enumerator:

kEnemyVisible	Sense enemy.
kEnemyAware	Aware of enemy (but might not see them).

---

Member Function Documentation

int CCmpSenses::set

(

const EDIT_DATA &

editData

)

[virtual]

Set a value.

If we have data of this type, use editData to set its value.

Parameters:

editData

Data type and value (see EDIT_DATA struct).

Returns:

Value less than zero on error, 0 if nothing found, positive otherwise.

See also:

EDIT_DATA

---

Handles the following EDIT_DATA:

• kEditFOV
  FOV angle.
  Data: 'int' angle in degrees.

• kEditSightRange
  Distance we can see (withing the FOV).
  Data: 'unit' with distance in quants.

• kEditHearRange
  Distance that we 'hear' an entity.
  Data: 'unit' with distance in quants.

• kEditReactionTime
  Edit how long between scans.
  Data: 'int' with number of ticks.

• kEditMemoryTime
  Edit how long we remember something.
  Data: 'int' with number of ticks.

Implements CCmp.

int CCmpSenses::get

(

EDIT_DATA &

editData

)

const [virtual]

Get a value.

If we have data of this type, use editData to get its value.

Parameters:

editData

Data type we are looking for, and memory to store value (see EDIT_DATA struct).

Returns:

Value less than zero on error, 0 if nothing found, positive otherwise.

See also:

EDIT_DATA

---

Handles the following EDIT_DATA:

• kEditFlagAll
  Get the entire group of flags. Data: 'long' with encoded flag values.

  See also:

  eFlags

• kEditFlag
  Get a flag state.
  Data: Before the call, 'int' should be set to the flag id we want to check. The state of that flag will be returned as a 'bool' (true for on, false for off).

  See also:

  eFlags

Implements CCmp.

int CCmpSenses::act

(

const ACTION_DATA &

actData

)

[virtual]

Preform an action.

Handle the action passed in (ignore if we do not handle the action type).

Parameters:

actData

The data used to preform the action (see ACTION_DATA struct).

Returns:

Value less than zero on error, 0 if no action found, positive otherwise.

See also:

ACTION_DATA

---

Handles the following ACTION_DATA:

• None.

Implements CCmp.

bool CCmpSenses::inFOV	(	CVector3D &	vUnit,
		unit	halfFOVRad
	)

In the GE's field-of-view?

Parameters:

	vUnit	Unit vector in the direction we are checking
	halfFOVRad	Half the FOV ang (messured in radians)

Returns:

true if vUnit is inside the FOV

bool CCmpSenses::inLOS

(

CGameEntity *

pTarget

)

In the GE's line-of-sight?

Parameters:

pTarget

Target object.

Returns:

true if you can trace to target

void CCmpSenses::memory_update	(	const OBJTYPE_DATA *	pData,
		CVector3D &	vPos,
		CVector3D &	vUnit,
		unit	dist,
		bool	bInFOV
	)

Add/update a memory record.

Parameters:

	pData	Pointer to the OBJTYPE_DATA
	vPos	Position of sensed object
	vUnit	Unit vector pointing to sensed object
	dist	Distance to sensed object
	bInFOV	IS this object in our Field-of-View?

void CCmpSenses::memory_prune

(

unit

timeTotal

)

Prune old records out of current list.

Parameters:

timeTotal

Total number of ticks since the start of the game.

bool CCmpSenses::memory_remove

(

long

id

)

Remove a memory record.

Parameters:

id

Entity ID of record to be removed.

Returns:

true if record found and removed.

SENSEMEMORY_DATA * CCmpSenses::memory_closest

(

)

Who's closest?

Returns:

Pointer to the closest enemy (NULL if none)

---

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

• C:/Documents and Settings/slap/My Documents/Visual Studio 2005/Projects/Template7/template7/cmpSenses.h
• C:/Documents and Settings/slap/My Documents/Visual Studio 2005/Projects/Template7/template7/cmpSenses.cpp

---