Torque Game Engine Documentation
TGE Version 1.5.2

ExplosionData Class Reference

#include <explosion.h>

Inheritance diagram for ExplosionData:


Public Types
enum	ExplosionConsts { EC_NUM_DEBRIS_TYPES = 1, EC_NUM_EMITTERS = 4, EC_MAX_SUB_EXPLOSIONS = 5, EC_NUM_TIME_KEYS = 4 }
typedef GameBaseData	Parent
Public Member Functions
	ExplosionData ()
	DECLARE_CONOBJECT (ExplosionData)
bool	onAdd ()
	Called when the object is added to the sim.
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)
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Data Fields
StringTableEntry	dtsFileName
bool	faceViewer
S32	particleDensity
F32	particleRadius
AudioProfile *	soundProfile
ParticleEmitterData *	particleEmitter
S32	soundProfileId
S32	particleEmitterId
Point3F	explosionScale
F32	playSpeed
Resource< TSShape >	explosionShape
S32	explosionAnimation
ParticleEmitterData *	emitterList [EC_NUM_EMITTERS]
S32	emitterIDList [EC_NUM_EMITTERS]
ShockwaveData *	shockwave
S32	shockwaveID
bool	shockwaveOnTerrain
DebrisData *	debrisList [EC_NUM_DEBRIS_TYPES]
S32	debrisIDList [EC_NUM_DEBRIS_TYPES]
F32	debrisThetaMin
F32	debrisThetaMax
F32	debrisPhiMin
F32	debrisPhiMax
S32	debrisNum
S32	debrisNumVariance
F32	debrisVelocity
F32	debrisVelocityVariance
ExplosionData *	explosionList [EC_MAX_SUB_EXPLOSIONS]
S32	explosionIDList [EC_MAX_SUB_EXPLOSIONS]
S32	delayMS
S32	delayVariance
S32	lifetimeMS
S32	lifetimeVariance
F32	offset
Point3F	sizes [EC_NUM_TIME_KEYS]
F32	times [EC_NUM_TIME_KEYS]
bool	shakeCamera
VectorF	camShakeFreq
VectorF	camShakeAmp
F32	camShakeDuration
F32	camShakeRadius
F32	camShakeFalloff
F32	lightStartRadius
F32	lightEndRadius
ColorF	lightStartColor
ColorF	lightEndColor

Member Typedef Documentation

typedef GameBaseData ExplosionData::Parent

Reimplemented from GameBaseData.

Member Enumeration Documentation

enum ExplosionData::ExplosionConsts

Enumerator:

EC_NUM_DEBRIS_TYPES
EC_NUM_EMITTERS
EC_MAX_SUB_EXPLOSIONS
EC_NUM_TIME_KEYS

Constructor & Destructor Documentation

ExplosionData::ExplosionData ( )

Member Function Documentation

ExplosionData::DECLARE_CONOBJECT ( ExplosionData )

bool ExplosionData::onAdd ( ) [virtual]

Called when the object is added to the sim.

Reimplemented from GameBaseData.

bool ExplosionData::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.