torque Torque Game Engine Documentation
TGE Version 1.5.2
Torque Home   Class Hierarchy   Data Structures   Namespaces   Namespace Members   File List   Globals

PrecipitationData Class Reference

#include <precipitation.h>

Inheritance diagram for PrecipitationData:

Inheritance graph
[legend]

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.

Data Fields

AudioProfile * soundProfile
S32 soundProfileId
 Ambient sound.
StringTableEntry mDropName
 Texture filename for raindrop.
StringTableEntry mSplashName
 Texture filename for splash.
F32 mDropSize
 Droplet billboard size.
F32 mSplashSize
 Splash billboard size.
bool mUseTrueBillboards
 True to use true billboards, false for axis-aligned billboards.
S32 mSplashMS
 How long in milliseconds a splash will last.

Private Types

typedef GameBaseData Parent

Member Typedef Documentation

typedef GameBaseData PrecipitationData::Parent [private]

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(), addDepricatedField(), 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.

Field Documentation

AudioProfile* PrecipitationData::soundProfile

S32 PrecipitationData::soundProfileId

Ambient sound.

StringTableEntry PrecipitationData::mDropName

Texture filename for raindrop.

StringTableEntry PrecipitationData::mSplashName

Texture filename for splash.

F32 PrecipitationData::mDropSize

Droplet billboard size.

F32 PrecipitationData::mSplashSize

Splash billboard size.

bool PrecipitationData::mUseTrueBillboards

True to use true billboards, false for axis-aligned billboards.

S32 PrecipitationData::mSplashMS

How long in milliseconds a splash will last.



All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen
© GarageGames.com Home Back to Top