torque Torque Game Engine Documentation
TGE Version 1.5.2

VehicleData Struct Reference

#include <vehicle.h>

Inheritance diagram for VehicleData:

Inheritance graph
[legend]

Public Types

enum  VehicleConsts {
  VC_NUM_DUST_EMITTERS = 1,
  VC_NUM_DAMAGE_EMITTER_AREAS = 2,
  VC_NUM_DAMAGE_LEVELS = 2,
  VC_NUM_BUBBLE_EMITTERS = 1,
  VC_NUM_DAMAGE_EMITTERS = VC_NUM_DAMAGE_LEVELS + VC_NUM_BUBBLE_EMITTERS,
  VC_NUM_SPLASH_EMITTERS = 2,
  VC_BUBBLE_EMITTER = VC_NUM_DAMAGE_EMITTERS - VC_NUM_BUBBLE_EMITTERS
}
enum  Sounds {
  ExitWater,
  ImpactSoft,
  ImpactMedium,
  ImpactHard,
  Wake,
  MaxSounds
}
typedef ShapeBaseData Parent

Public Member Functions

 VehicleData ()
bool preload (bool server, char errorBuffer[256])
 Called to prepare the datablock for use, after it has been unpacked.
virtual void packData (BitStream *stream)
virtual void unpackData (BitStream *stream)
 DECLARE_CONOBJECT (VehicleData)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Data Fields

VehicleData::Body body
AudioProfilewaterSound [MaxSounds]
F32 exitSplashSoundVel
F32 softSplashSoundVel
F32 medSplashSoundVel
F32 hardSplashSoundVel
F32 minImpactSpeed
F32 softImpactSpeed
F32 hardImpactSpeed
F32 minRollSpeed
F32 maxSteeringAngle
F32 collDamageThresholdVel
F32 collDamageMultiplier
bool cameraRoll
 Roll the 3rd party camera.
F32 cameraLag
 Amount of camera lag (lag += car velocity * lag).
F32 cameraDecay
 Rate at which camera returns to target pos.
F32 cameraOffset
 Vertical offset.
F32 minDrag
F32 maxDrag
S32 integration
 # of physics steps per tick
F32 collisionTol
 Collision distance tolerance.
F32 contactTol
 Contact velocity tolerance.
Point3F massCenter
 Center of mass for rigid body.
Point3F massBox
 Size of inertial box.
F32 jetForce
F32 jetEnergyDrain
 Energy drain/tick.
F32 minJetEnergy
ParticleEmitterDatadustEmitter
S32 dustID
F32 triggerDustHeight
 height vehicle has to be under to kick up dust
F32 dustHeight
 dust height above ground
ParticleEmitterDatadamageEmitterList [VC_NUM_DAMAGE_EMITTERS]
Point3F damageEmitterOffset [VC_NUM_DAMAGE_EMITTER_AREAS]
S32 damageEmitterIDList [VC_NUM_DAMAGE_EMITTERS]
F32 damageLevelTolerance [VC_NUM_DAMAGE_LEVELS]
F32 numDmgEmitterAreas
ParticleEmitterDatasplashEmitterList [VC_NUM_SPLASH_EMITTERS]
S32 splashEmitterIDList [VC_NUM_SPLASH_EMITTERS]
F32 splashFreqMod
F32 splashVelEpsilon

Data Structures

struct  Body

Member Typedef Documentation


Member Enumeration Documentation

Enumerator:
VC_NUM_DUST_EMITTERS 
VC_NUM_DAMAGE_EMITTER_AREAS 
VC_NUM_DAMAGE_LEVELS 
VC_NUM_BUBBLE_EMITTERS 
VC_NUM_DAMAGE_EMITTERS 
VC_NUM_SPLASH_EMITTERS 
VC_BUBBLE_EMITTER 

Enumerator:
ExitWater 
ImpactSoft 
ImpactMedium 
ImpactHard 
Wake 
MaxSounds 

Reimplemented in FlyingVehicleData, HoverVehicleData, and WheeledVehicleData.


Constructor & Destructor Documentation

VehicleData::VehicleData (  ) 


Member Function Documentation

bool VehicleData::preload ( bool  server,
char  errorBuffer[256] 
) [virtual]

Called to prepare the datablock for use, after it has been unpacked.

Parameters:
server Set if we're running on the server (and therefore don't need to load things like textures or sounds).
errorBuffer If an error occurs in loading, this is set to a short string describing the error.
Returns:
True if all went well; false if something failed.
See also:
preload() and File Downloading

Reimplemented from ShapeBaseData.

Reimplemented in FlyingVehicleData, HoverVehicleData, and WheeledVehicleData.

static void VehicleData::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from ShapeBaseData.

Reimplemented in FlyingVehicleData, HoverVehicleData, and WheeledVehicleData.

virtual void VehicleData::packData ( BitStream stream  )  [virtual]

Reimplemented from ShapeBaseData.

Reimplemented in FlyingVehicleData, HoverVehicleData, and WheeledVehicleData.

virtual void VehicleData::unpackData ( BitStream stream  )  [virtual]

Reimplemented from ShapeBaseData.

Reimplemented in FlyingVehicleData, HoverVehicleData, and WheeledVehicleData.

VehicleData::DECLARE_CONOBJECT ( VehicleData   ) 


Field Documentation

Roll the 3rd party camera.

Amount of camera lag (lag += car velocity * lag).

Rate at which camera returns to target pos.

Vertical offset.

# of physics steps per tick

Contact velocity tolerance.

Center of mass for rigid body.

Size of inertial box.

Energy drain/tick.

height vehicle has to be under to kick up dust

dust height above ground

Point3F VehicleData::damageEmitterOffset[VC_NUM_DAMAGE_EMITTER_AREAS]

S32 VehicleData::damageEmitterIDList[VC_NUM_DAMAGE_EMITTERS]

F32 VehicleData::damageLevelTolerance[VC_NUM_DAMAGE_LEVELS]

S32 VehicleData::splashEmitterIDList[VC_NUM_SPLASH_EMITTERS]




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen