CCmpObjType Class Reference

Object Type Gives the GE a 'type' that can be scanned by other entities. More...

#include <cmpObjType.h>

Inheritance diagram for CCmpObjType:

List of all members.

Public Member Functions
	CCmpObjType (CGameEntity *pGE)
	Create with default values.
void	type_set (OBJTYPE_DATA::eType type)
	Set or change the object type (updating object lists if needed).
OBJTYPE_DATA::eType	type_get () const
	Returns: The Object Type
void	value_set (int value)
	Set or change the object value (updating object lists if needed).
int	value_get () const
	Returns: The value (-1 if none)
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.

---

Detailed Description

Object Type Gives the GE a 'type' that can be scanned by other entities.

(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 Function Documentation

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

• kEditType
  The object type.
  Data: 'int' with type.

  See also:

  OBJTYPE_DATA::eType

• kEditValue
  Object value (i.e. team number, size, cost, etc.).
  Data: 'int' with value.

  See also:

  OBJTYPE_DATA

Implements CCmp.

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

• kEditType
  The object type.
  Data: 'int' with type.

  See also:

  OBJTYPE_DATA::eType

• kEditValue
  Object value (i.e. team number, size, cost, etc.).
  Data: 'int' with value.

  See also:

  OBJTYPE_DATA

Implements CCmp.

int CCmpObjType::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.

void CCmpObjType::type_set

(

OBJTYPE_DATA::eType

type

)

Set or change the object type (updating object lists if needed).

Parameters:

type

The type of object we want to become.

void CCmpObjType::value_set

(

int

value

)

Set or change the object value (updating object lists if needed).

Parameters:

value

The value

---

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

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

---