CEL

Public API Reference

Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members

iPcActorMove Struct Reference

ActorMove property class. More...

#include <propclass/actormove.h>

List of all members.

Public Member Functions

virtual void Forward (bool start)=0
 Start/stop going forward.
virtual bool IsMovingForward ()=0
 Returns the toogle value of moving forward.
virtual void Backward (bool start)=0
 Start/stop going backward.
virtual bool IsMovingBackward ()=0
 Returns the toogle value of moving backward.
virtual void StrafeLeft (bool start)=0
 Start/stop strafing left.
virtual bool IsStrafingLeft ()=0
 Returns the toogle value of strafing left.
virtual void StrafeRight (bool start)=0
 Start/stop strafing right.
virtual bool IsStrafingRight ()=0
 Returns the toogle value of strafing right.
virtual void RotateLeft (bool start)=0
 Start/stop rotating left.
virtual bool IsRotatingLeft ()=0
 Returns the toogle value of rotating left.
virtual void RotateRight (bool start)=0
 Start/stop rotating right.
virtual bool IsRotatingRight ()=0
 Returns the toogle value of rotating right.
virtual void RotateTo (float yrot)=0
 Rotate to a specified angle.
virtual void Run (bool start)=0
 Start/stop running.
virtual bool IsRunning ()=0
 Returns the toogle value of running.
virtual void AutoRun (bool start)=0
 Start/stop auto-running.
virtual bool IsAutoRunning ()=0
 Returns the toogle value of autorunning.
virtual void Jump ()=0
 Jump.
virtual void ToggleCameraMode ()=0
 Toggle camera mode.
virtual void SetMovementSpeed (float speed)=0
 Set the movement speed (default 2.0).
virtual float GetMovementSpeed () const =0
 Get the movement speed (default 2.0).
virtual void SetRunningSpeed (float speed)=0
 Set the running speed (default 5.0).
virtual float GetRunningSpeed () const =0
 Get the running speed (default 5.0).
virtual void SetRotationSpeed (float speed)=0
 Set the rotation speed (default 1.75).
virtual float GetRotationSpeed () const =0
 Get the rotation speed (default 1.75).
virtual void SetJumpingVelocity (float speed)=0
 Set the jumping velocity (default 6.31).
virtual float GetJumpingVelocity () const =0
 Get the jumping velocity (default 6.31).


Detailed Description

ActorMove property class.

This property class makes a connection between pclinmove and pccamera and makes it easier to control movement for actors in a game. Typical usage would be to combine it with pccommandinput and then in the behaviour layer send out the appropriate calls here depending on the keys that are pressed. This class is also aware of animation actions using sprcal3d or spr3d.

This property class supports the following actions (add prefix 'cel.action.' to get the ID of the action and add prefix 'cel.parameter.' to get the ID of the parameter):

Definition at line 54 of file actormove.h.


Member Function Documentation

virtual void iPcActorMove::AutoRun bool  start  )  [pure virtual]
 

Start/stop auto-running.

virtual void iPcActorMove::Backward bool  start  )  [pure virtual]
 

Start/stop going backward.

virtual void iPcActorMove::Forward bool  start  )  [pure virtual]
 

Start/stop going forward.

virtual float iPcActorMove::GetJumpingVelocity  )  const [pure virtual]
 

Get the jumping velocity (default 6.31).

virtual float iPcActorMove::GetMovementSpeed  )  const [pure virtual]
 

Get the movement speed (default 2.0).

virtual float iPcActorMove::GetRotationSpeed  )  const [pure virtual]
 

Get the rotation speed (default 1.75).

virtual float iPcActorMove::GetRunningSpeed  )  const [pure virtual]
 

Get the running speed (default 5.0).

virtual bool iPcActorMove::IsAutoRunning  )  [pure virtual]
 

Returns the toogle value of autorunning.

virtual bool iPcActorMove::IsMovingBackward  )  [pure virtual]
 

Returns the toogle value of moving backward.

virtual bool iPcActorMove::IsMovingForward  )  [pure virtual]
 

Returns the toogle value of moving forward.

virtual bool iPcActorMove::IsRotatingLeft  )  [pure virtual]
 

Returns the toogle value of rotating left.

virtual bool iPcActorMove::IsRotatingRight  )  [pure virtual]
 

Returns the toogle value of rotating right.

virtual bool iPcActorMove::IsRunning  )  [pure virtual]
 

Returns the toogle value of running.

virtual bool iPcActorMove::IsStrafingLeft  )  [pure virtual]
 

Returns the toogle value of strafing left.

virtual bool iPcActorMove::IsStrafingRight  )  [pure virtual]
 

Returns the toogle value of strafing right.

virtual void iPcActorMove::Jump  )  [pure virtual]
 

Jump.

virtual void iPcActorMove::RotateLeft bool  start  )  [pure virtual]
 

Start/stop rotating left.

virtual void iPcActorMove::RotateRight bool  start  )  [pure virtual]
 

Start/stop rotating right.

virtual void iPcActorMove::RotateTo float  yrot  )  [pure virtual]
 

Rotate to a specified angle.

virtual void iPcActorMove::Run bool  start  )  [pure virtual]
 

Start/stop running.

virtual void iPcActorMove::SetJumpingVelocity float  speed  )  [pure virtual]
 

Set the jumping velocity (default 6.31).

virtual void iPcActorMove::SetMovementSpeed float  speed  )  [pure virtual]
 

Set the movement speed (default 2.0).

virtual void iPcActorMove::SetRotationSpeed float  speed  )  [pure virtual]
 

Set the rotation speed (default 1.75).

virtual void iPcActorMove::SetRunningSpeed float  speed  )  [pure virtual]
 

Set the running speed (default 5.0).

virtual void iPcActorMove::StrafeLeft bool  start  )  [pure virtual]
 

Start/stop strafing left.

virtual void iPcActorMove::StrafeRight bool  start  )  [pure virtual]
 

Start/stop strafing right.

virtual void iPcActorMove::ToggleCameraMode  )  [pure virtual]
 

Toggle camera mode.


The documentation for this struct was generated from the following file:
Generated for CEL: Crystal Entity Layer by doxygen 1.4.4