SplashData Class Reference

#include <splash.h>

Inheritance diagram for SplashData:

Inheritance graph
[legend]
List of all members.

Public Types

typedef GameBaseData Parent
 NUM_EMITTERS = 3
 NUM_TIME_KEYS = 4
 NUM_TEX = 2
enum  Constants {
  NUM_EMITTERS = 3,
  NUM_TIME_KEYS = 4,
  NUM_TEX = 2
}

Public Member Functions

 SplashData ()
 DECLARE_CONOBJECT (SplashData)
bool onAdd ()
 Called when the object is added to the sim.
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)

Static Public Member Functions

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

Public Attributes

AudioProfile * soundProfile
S32 soundProfileId
ParticleEmitterDataemitterList [NUM_EMITTERS]
S32 emitterIDList [NUM_EMITTERS]
S32 delayMS
S32 delayVariance
S32 lifetimeMS
S32 lifetimeVariance
Point3F scale
F32 width
F32 height
U32 numSegments
F32 velocity
F32 acceleration
F32 texWrap
F32 texFactor
F32 ejectionFreq
F32 ejectionAngle
F32 ringLifetime
F32 startRadius
F32 times [NUM_TIME_KEYS]
ColorF colors [NUM_TIME_KEYS]
StringTableEntry textureName [NUM_TEX]
GFXTexHandle textureHandle [NUM_TEX]
ExplosionDataexplosion
S32 explosionId

Member Typedef Documentation

Reimplemented from GameBaseData.


Member Enumeration Documentation

Enumerator:
NUM_EMITTERS 
NUM_TIME_KEYS 
NUM_TEX 


Constructor & Destructor Documentation

SplashData::SplashData (  ) 


Member Function Documentation

SplashData::DECLARE_CONOBJECT ( SplashData   ) 

bool SplashData::onAdd (  )  [virtual]

Called when the object is added to the sim.

Reimplemented from GameBaseData.

bool SplashData::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.
Returns:
True if all went well; false if something failed.
See also:
preload() and File Downloading

Reimplemented from GameBaseData.

static void SplashData::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GameBaseData.

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

Reimplemented from SimDataBlock.

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

Reimplemented from GameBaseData.


Member Data Documentation

AudioProfile* SplashData::soundProfile

F32 SplashData::times[NUM_TIME_KEYS]

ColorF SplashData::colors[NUM_TIME_KEYS]