torque Torque Game Engine Documentation
TGE Version 1.5.2

WeatherLightningData Class Reference

#include <weatherLightning.h>

Inheritance diagram for WeatherLightningData:

Inheritance graph
[legend]

Public Types

enum  {
  MaxSounds = 4,
  MaxStrikeTextures = 6,
  MaxFlashTextures = 4,
  MaxFuzzyTextures = 2
}

Public Member Functions

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

Static Public Member Functions

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

Data Fields

U32 numStrikes
StringTableEntry strikeTextureNames [MaxStrikeTextures]
TextureHandle strikeTextures [MaxStrikeTextures]
U32 numFlashes
StringTableEntry flashTextureNames [MaxFlashTextures]
TextureHandle flashTextures [MaxFlashTextures]
U32 numFuzzes
StringTableEntry fuzzyTextureNames [MaxFuzzyTextures]
TextureHandle fuzzyTextures [MaxFuzzyTextures]
S32 strikeSoundId
AudioProfilestrikeSound
U32 numSounds
S32 thunderSoundIds [MaxSounds]
AudioProfilethunderSounds [MaxSounds]

Protected Member Functions

bool onAdd ()
 Called when the object is added to the sim.

Private Types

typedef GameBaseData Parent

Member Typedef Documentation

Reimplemented from GameBaseData.


Member Enumeration Documentation

anonymous enum

Enumerator:
MaxSounds 
MaxStrikeTextures 
MaxFlashTextures 
MaxFuzzyTextures 


Constructor & Destructor Documentation

WeatherLightningData::WeatherLightningData (  ) 

WeatherLightningData::~WeatherLightningData (  ) 


Member Function Documentation

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

Called when the object is added to the sim.

Reimplemented from GameBaseData.

void WeatherLightningData::packData ( BitStream  )  [virtual]

Reimplemented from SimDataBlock.

void WeatherLightningData::unpackData ( BitStream  )  [virtual]

Reimplemented from GameBaseData.

bool WeatherLightningData::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 GameBaseData.

WeatherLightningData::DECLARE_CONOBJECT ( WeatherLightningData   ) 

static void WeatherLightningData::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GameBaseData.


Field Documentation

TextureHandle WeatherLightningData::strikeTextures[MaxStrikeTextures]

TextureHandle WeatherLightningData::flashTextures[MaxFlashTextures]

TextureHandle WeatherLightningData::fuzzyTextures[MaxFuzzyTextures]




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