VehicleData Struct Reference

#include <vehicle.h>

Inheritance diagram for VehicleData:


Public Types
typedef ShapeBaseData	Parent
	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
	ExitWater
	ImpactSoft
	ImpactMedium
	ImpactHard
	Wake
	MaxSounds
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 }
Public Member Functions
	VehicleData ()
bool	preload (bool server, String &errorStr)
	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.
Public Attributes
VehicleData::Body	body
SFXProfile *	waterSound [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
ParticleEmitterData *	dustEmitter
S32	dustID
F32	triggerDustHeight
	height vehicle has to be under to kick up dust
F32	dustHeight
	dust height above ground
ParticleEmitterData *	damageEmitterList [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
ParticleEmitterData *	splashEmitterList [VC_NUM_SPLASH_EMITTERS]
S32	splashEmitterIDList [VC_NUM_SPLASH_EMITTERS]
F32	splashFreqMod
F32	splashVelEpsilon
Classes
struct	Body

Member Typedef Documentation

typedef ShapeBaseData VehicleData::Parent

Reimplemented from ShapeBaseData.

Reimplemented in FlyingVehicleData, HoverVehicleData, and WheeledVehicleData.

Member Enumeration Documentation

enum VehicleData::VehicleConsts

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

enum VehicleData::Sounds

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,
		String &	errorStr
	)			`[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).
	errorStr	If an error occurs in loading, this is set to a short string describing the error.