torque Torque Game Engine Documentation
TGE Version 1.5.2
Torque Home   Class Hierarchy   Data Structures   Namespaces   Namespace Members   File List   Globals

HoverVehicle Class Reference

#include <hoverVehicle.h>

Inheritance diagram for HoverVehicle:

Inheritance graph
[legend]

Public Member Functions

 HoverVehicle ()
 ~HoverVehicle ()
void advanceTime (F32 dt)
 Advances simulation time for animations.
 DECLARE_CONOBJECT (HoverVehicle)
U32 packUpdate (NetConnection *conn, U32 mask, BitStream *stream)
 Instructs this object to pack its state for transfer over the network.
void unpackUpdate (NetConnection *conn, BitStream *stream)
 Instructs this object to read state data previously packed with packUpdate.

Protected Types

enum  ThrustDirection {
  ThrustForward,
  ThrustBackward,
  ThrustDown,
  NumThrustDirections,
  NumThrustBits = 3
}
enum  Jets {
  BackActivate,
  BackMaintain,
  JetAnimCount
}

Protected Member Functions

bool onAdd ()
 Called when the object is added to the sim.
void onRemove ()
 Called when the object is removed from the sim.
bool onNewDataBlock (GameBaseData *dptr)
 Called when a new datablock is set.
void updateDustTrail (F32 dt)
void updateMove (const Move *move)
void updateForces (F32)
F32 getBaseStabilizerLength () const
U32 getCollisionMask ()
void updateJet (F32 dt)
void updateEmitter (bool active, F32 dt, ParticleEmitterData *emitter, S32 idx, S32 count)

Protected Attributes

bool mFloating
F32 mThrustLevel
F32 mForwardThrust
F32 mReverseThrust
F32 mLeftThrust
F32 mRightThrust
AUDIOHANDLE mJetSound
AUDIOHANDLE mEngineSound
AUDIOHANDLE mFloatSound
ThrustDirection mThrustDirection
TSThread * mJetThread [JetAnimCount]
S32 mJetSeq [JetAnimCount]
bool mBackMaintainOn
SimObjectPtr< ParticleEmitter > mJetEmitter [HoverVehicleData::MaxJetNodes]

Static Protected Attributes

static const char * sJetSequence [HoverVehicle::JetAnimCount]
static JetActivation sJetActivation [NumThrustDirections]

Private Types

typedef Vehicle Parent

Private Attributes

HoverVehicleData * mDataBlock
 Datablock.
ParticleEmitter * mDustTrailEmitter

Data Structures

struct  JetActivation

Member Typedef Documentation

typedef Vehicle HoverVehicle::Parent [private]

Reimplemented from Vehicle.

Member Enumeration Documentation

enum HoverVehicle::ThrustDirection [protected]

Enumerator:
ThrustForward 
ThrustBackward 
ThrustDown 
NumThrustDirections 
NumThrustBits 

enum HoverVehicle::Jets [protected]

Enumerator:
BackActivate 
BackMaintain 
JetAnimCount 

Constructor & Destructor Documentation

HoverVehicle::HoverVehicle (  ) 

HoverVehicle::~HoverVehicle (  ) 

Member Function Documentation

bool HoverVehicle::onAdd (  )  [protected, virtual]

Called when the object is added to the sim.

Reimplemented from Vehicle.

void HoverVehicle::onRemove (  )  [protected, virtual]

Called when the object is removed from the sim.

Reimplemented from Vehicle.

bool HoverVehicle::onNewDataBlock ( GameBaseData *  dptr  )  [protected, virtual]

Called when a new datablock is set.

This allows subclasses to appropriately handle new datablocks.

See also:
setDataBlock()
Parameters:
dptr New datablock

Reimplemented from Vehicle.

void HoverVehicle::updateDustTrail ( F32  dt  )  [protected]

void HoverVehicle::updateMove ( const Move *  move  )  [protected, virtual]

Reimplemented from Vehicle.

void HoverVehicle::updateForces ( F32   )  [protected, virtual]

Reimplemented from Vehicle.

F32 HoverVehicle::getBaseStabilizerLength (  )  const [protected]

U32 HoverVehicle::getCollisionMask (  )  [protected, virtual]

Reimplemented from Vehicle.

void HoverVehicle::updateJet ( F32  dt  )  [protected]

void HoverVehicle::updateEmitter ( bool  active,
F32  dt,
ParticleEmitterData *  emitter,
S32  idx,
S32  count 
) [protected]

void HoverVehicle::advanceTime ( F32  dt  )  [virtual]

Advances simulation time for animations.

This is called every frame.

Parameters:
dt Time since last advance call

Reimplemented from Vehicle.

HoverVehicle::DECLARE_CONOBJECT ( HoverVehicle   ) 

U32 HoverVehicle::packUpdate ( NetConnection *  conn,
U32  mask,
BitStream *  stream 
) [virtual]

Instructs this object to pack its state for transfer over the network.

Parameters:
conn Net connection being used
mask Mask indicating fields to transmit.
stream Bitstream to pack data to
Returns:
Any bits which were not dealt with. The value is stored by the networking system. Don't set bits you weren't passed.

Reimplemented from Vehicle.

void HoverVehicle::unpackUpdate ( NetConnection *  conn,
BitStream *  stream 
) [virtual]

Instructs this object to read state data previously packed with packUpdate.

Parameters:
conn Net connection being used
stream stream to read from

Reimplemented from Vehicle.

Field Documentation

HoverVehicleData* HoverVehicle::mDataBlock [private]

Datablock.

Reimplemented from Vehicle.

ParticleEmitter* HoverVehicle::mDustTrailEmitter [private]

bool HoverVehicle::mFloating [protected]

F32 HoverVehicle::mThrustLevel [protected]

F32 HoverVehicle::mForwardThrust [protected]

F32 HoverVehicle::mReverseThrust [protected]

F32 HoverVehicle::mLeftThrust [protected]

F32 HoverVehicle::mRightThrust [protected]

AUDIOHANDLE HoverVehicle::mJetSound [protected]

AUDIOHANDLE HoverVehicle::mEngineSound [protected]

AUDIOHANDLE HoverVehicle::mFloatSound [protected]

ThrustDirection HoverVehicle::mThrustDirection [protected]

const char* HoverVehicle::sJetSequence[HoverVehicle::JetAnimCount] [static, protected]

TSThread* HoverVehicle::mJetThread[JetAnimCount] [protected]

S32 HoverVehicle::mJetSeq[JetAnimCount] [protected]

bool HoverVehicle::mBackMaintainOn [protected]

JetActivation HoverVehicle::sJetActivation[NumThrustDirections] [static, protected]

SimObjectPtr<ParticleEmitter> HoverVehicle::mJetEmitter[HoverVehicleData::MaxJetNodes] [protected]



All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen
© GarageGames.com Home Back to Top