PrecipitationData Class Reference

#include <precipitation.h>

Inheritance diagram for PrecipitationData:

Inheritance graph
[legend]
List of all members.

Detailed Description

Precipitation datablock.


Public Member Functions

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

SFXProfilesoundProfile
S32 soundProfileId
 Ambient sound.
StringTableEntry mDropName
 Texture filename for drop particles.
StringTableEntry mDropShaderName
 The name of the shader used for raindrops.
StringTableEntry mSplashName
 Texture filename for splash particles.
StringTableEntry mSplashShaderName
 The name of the shader used for raindrops.
S32 mDropsPerSide
 How many drops are on a side of the raindrop texture.
S32 mSplashesPerSide
 How many splash are on a side of the splash texture.

Private Types

typedef GameBaseData Parent


Member Typedef Documentation

Reimplemented from GameBaseData.


Constructor & Destructor Documentation

PrecipitationData::PrecipitationData (  ) 


Member Function Documentation

PrecipitationData::DECLARE_CONOBJECT ( PrecipitationData   ) 

bool PrecipitationData::onAdd (  )  [virtual]

Called when the object is added to the sim.

Reimplemented from GameBaseData.

static void PrecipitationData::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GameBaseData.

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

Reimplemented from SimDataBlock.

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

Reimplemented from GameBaseData.


Member Data Documentation

Texture filename for drop particles.

The name of the shader used for raindrops.

Texture filename for splash particles.

The name of the shader used for raindrops.

How many drops are on a side of the raindrop texture.

How many splash are on a side of the splash texture.