CEL

Public API Reference

iPcCraftController Struct Reference

This is a property class used to control movement of an hovercraft. More...

#include <propclass/craft.h>

Inheritance diagram for iPcCraftController:

List of all members.

Public Member Functions

virtual void AfterBurnerOff ()=0
 Turn off afterburner.
virtual void AfterBurnerOn ()=0
 Turn on afterburner.
virtual void BrakesOff ()=0
 Turn off brakes.
virtual void BrakesOn ()=0
 Turn on brakes.
virtual bool IsThrusterOn ()=0
 Report whether thruster is on (true) or turned off (false).
virtual void SetAccPitch (float uacc)=0
 Set the objects up and down turning acceleration.
virtual void SetAccTurn (float tacc)=0
 Set the objects left and right turning acceleration.
virtual void SetAfterBurnerTopSpeed (float tspeed)=0
 Set the top speed when afterburner is on.
virtual void SetBrakingSpeed (float bspd)=0
 Set the braking force.
virtual void SetDecelerationRate (float decr)=0
 Set the deceleration rate.
virtual void SetMaxPitch (float mud)=0
 Set the objects maximum up and down turning velocity.
virtual void SetMaxTurn (float turn)=0
 Set the objects maximum left and right turning velocity.
virtual void SetRedirectVelocityRatio (float rdvr)=0
 @@@ Document me !
virtual void SetRoll (float roll)=0
 Set the roll factor.
virtual void SetThrustForce (float tf)=0
 Set the thrust force of the craft.
virtual void SetTopSpeed (float tspeed)=0
 Set the Top Speed of the thruster.
virtual void SlideOff ()=0
 Turn off sliding.
virtual void SlideOn ()=0
 Turn on sliding.
virtual void StartTurnDown ()=0
 Start the object turning down.
virtual void StartTurnLeft ()=0
 Start the object turning left.
virtual void StartTurnRight ()=0
 Start the object turning right.
virtual void StartTurnUp ()=0
 Start the object turning up.
virtual void StopTurnDown ()=0
 Stop the object turning down.
virtual void StopTurnLeft ()=0
 Stop the object turning left.
virtual void StopTurnRight ()=0
 Stop the object turning right.
virtual void StopTurnUp ()=0
 Stop the object turning up.
virtual void ThrustOff ()=0
 Turn off thruster.
virtual void ThrustOn ()=0
 Turn on thruster.

Detailed Description

This is a property class used to control movement of an hovercraft.

Allows changing yaw and pitch, as well as thruster and afterburner, and supresses angular velocity of object.

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):

This property class supports the following properties (add prefix 'cel.property.' to get the ID of the property:

Definition at line 58 of file craft.h.


Member Function Documentation

virtual void iPcCraftController::AfterBurnerOff (  )  [pure virtual]

Turn off afterburner.

virtual void iPcCraftController::AfterBurnerOn (  )  [pure virtual]

Turn on afterburner.

virtual void iPcCraftController::BrakesOff (  )  [pure virtual]

Turn off brakes.

virtual void iPcCraftController::BrakesOn (  )  [pure virtual]

Turn on brakes.

virtual bool iPcCraftController::IsThrusterOn (  )  [pure virtual]

Report whether thruster is on (true) or turned off (false).

virtual void iPcCraftController::SetAccPitch ( float  uacc  )  [pure virtual]

Set the objects up and down turning acceleration.

virtual void iPcCraftController::SetAccTurn ( float  tacc  )  [pure virtual]

Set the objects left and right turning acceleration.

virtual void iPcCraftController::SetAfterBurnerTopSpeed ( float  tspeed  )  [pure virtual]

Set the top speed when afterburner is on.

Above this speed the afterburner will be disabled.

virtual void iPcCraftController::SetBrakingSpeed ( float  bspd  )  [pure virtual]

Set the braking force.

It is used to slow down the craft when brakes are on.

virtual void iPcCraftController::SetDecelerationRate ( float  decr  )  [pure virtual]

Set the deceleration rate.

It is used to slow down the craft when thruster is off.

virtual void iPcCraftController::SetMaxPitch ( float  mud  )  [pure virtual]

Set the objects maximum up and down turning velocity.

virtual void iPcCraftController::SetMaxTurn ( float  turn  )  [pure virtual]

Set the objects maximum left and right turning velocity.

virtual void iPcCraftController::SetRedirectVelocityRatio ( float  rdvr  )  [pure virtual]

@@@ Document me !

virtual void iPcCraftController::SetRoll ( float  roll  )  [pure virtual]

Set the roll factor.

Roll is how much a craft rolls when turning left and right.

virtual void iPcCraftController::SetThrustForce ( float  tf  )  [pure virtual]

Set the thrust force of the craft.

virtual void iPcCraftController::SetTopSpeed ( float  tspeed  )  [pure virtual]

Set the Top Speed of the thruster.

Above this speed the thruster will be disabled.

virtual void iPcCraftController::SlideOff (  )  [pure virtual]

Turn off sliding.

virtual void iPcCraftController::SlideOn (  )  [pure virtual]

Turn on sliding.

When sliding, the craft velocity is independent of its orientation.

virtual void iPcCraftController::StartTurnDown (  )  [pure virtual]

Start the object turning down.

virtual void iPcCraftController::StartTurnLeft (  )  [pure virtual]

Start the object turning left.

virtual void iPcCraftController::StartTurnRight (  )  [pure virtual]

Start the object turning right.

virtual void iPcCraftController::StartTurnUp (  )  [pure virtual]

Start the object turning up.

virtual void iPcCraftController::StopTurnDown (  )  [pure virtual]

Stop the object turning down.

virtual void iPcCraftController::StopTurnLeft (  )  [pure virtual]

Stop the object turning left.

virtual void iPcCraftController::StopTurnRight (  )  [pure virtual]

Stop the object turning right.

virtual void iPcCraftController::StopTurnUp (  )  [pure virtual]

Stop the object turning up.

virtual void iPcCraftController::ThrustOff (  )  [pure virtual]

Turn off thruster.

virtual void iPcCraftController::ThrustOn (  )  [pure virtual]

Turn on thruster.


The documentation for this struct was generated from the following file:

Generated for CEL: Crystal Entity Layer 1.4.1 by doxygen 1.7.1