CCmpControl Class Reference

Entity Controller Component. More...

#include <cmpControl.h>

Inheritance diagram for CCmpControl:

List of all members.

Public Types
enum	eType { , kAI = 0, kUser = 1, kDest = 2, kNet = 3 }
	Type of control. More...
enum	eCntlFlags {   kFlagJump = 1, kFlagDuck = 4, kFlagAttack = 5, kFlagReload = 6,   kFlagSwitch = 7 }
	Actions that can be requested. More...
Public Member Functions
	CCmpControl (CGameEntity *pGE)
	Create with default values.
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.
Static Public Attributes
static const eType	kDefaultType = CCmpControl::kAI
	What type of control this is (joypad, function, keyboard, etc).
Friends
class	CCmpBrain

---

Detailed Description

Entity Controller Component.

(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 CCmpControl::eType

Type of control.

Enumerator:

kAI	Forces/flags set by other CMPs or lite-C script.
kUser	User input (keyboard, mouse, joystick), "userInput.h".
kDest	Calc forces to get to kEditDestVec.
kNet	Network control (remote user).

enum CCmpControl::eCntlFlags

Actions that can be requested.

Enumerator:

kFlagJump	Jump.
kFlagDuck	Duck.
kFlagAttack	Attack target.
kFlagReload	Reload weapon.
kFlagSwitch	Switch weapon/item.

---

Member Function Documentation

int CCmpControl::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:

• kEditForce
  Set forces used for movement.
  Data: 'vec' with directed movement forces.

• kEditAForce
  Set angular forces used for rotation.
  Data: 'ang' with rotation forces.

• kEditType
  Set the type of controller
  Data: 'int' with controller type.

  See also:

  eType

• kEditFlag
  Set a control flag.
  Data: 'int' with the control flag id.

  See also:

  eCntlFlags

• kEditFlagReset
  Reset (clear) a control flag.
  Data: 'int' with the control flag id.

  See also:

  eCntlFlags

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

  See also:

  eCntlFlags

Implements CCmp.

int CCmpControl::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:

• kEditForce
  Get forces used for movement.
  Data: 'vec' with directed movement forces.

• kEditAForce
  Set angular forces used for rotation.
  Data: 'ang' with rotation forces.

• kEditType
  Get the type of controller
  Data: 'int' with controller type.

  See also:

  eType

• kEditFlag
  Get a control flag state.
  Data: Before the call, 'int' should be set to the control 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:

  eCntlFlags

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

  See also:

  eCntlFlags

Implements CCmp.

int CCmpControl::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:

• kActGotoDest
  Not yet used.

Implements CCmp.

---

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

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

---