CCmpMoveLift Class Reference

Lift movement component. More...

#include <cmpMoveLift.h>

Inheritance diagram for CCmpMoveLift:

List of all members.

Public Member Functions
	CCmpMoveLift (CGameEntity *pGE)
	Create with default values.
bool	do_activate ()
	Try to activate.
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
Default values
static const unit	kDefaultSpeed = 25
	Linear movement speed (quants/sec).
static const int	kDefaultMoveMode = IGNORE_PASSABLE + IGNORE_PUSH + IGNORE_CONTENT
	Movement parameters.

---

Detailed Description

Lift movement component.

Moves the object between its starting point and ending point when activated.

(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 CCmpMoveLift::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:

• kEditSpeed
  Movement speed.
  Data: 'unit' speed in quants/sec.

• kEditMoveMode
  The MOVE_MODE.
  Data: 'int' with encoded MOVE_MODE flags.

• kEditDestVec
  Set end point.
  Data: 'vec' with endpoint offset from the starting point.

• kEditDelayTime
  Time to wait at end before lift can be activated again.
  Data: 'unit' time in ticks.

• kEditAutoReturn
  Return to start after reaching end?
  Data: 'bool' true if we want to auto-return.

Implements CCmp.

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

• kEditSpeed
  Movement speed.
  Data: 'unit' speed in quants/sec.

• kEditMoveMode
  The MOVE_MODE.
  Data: 'int' with encoded MOVE_MODE flags.

• kEditDestVec
  Get end point.
  Data: 'vec' with absolute endpoint.

• kEditDelayTime
  Time to wait at end before lift can be activated again.
  Data: 'unit' time in ticks.

• kEditDist
  Distance we moved in the last frame.
  Data: 'unit' distance in quants.

Implements CCmp.

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

• kActActivate
  Handle activation event.
  Data: none

Implements CCmp.

bool CCmpMoveLift::do_activate

(

)

Try to activate.

Returns:

true if activated, otherwise false (e.g. busy)

---

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

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

---