torque Torque Game Engine Documentation
TGE Version 1.5.2

FireballAtmosphere Class Reference

#include <fireballAtmosphere.h>

Inheritance diagram for FireballAtmosphere:

Inheritance graph
[legend]

Public Member Functions

 FireballAtmosphere ()
bool onNewDataBlock (GameBaseData *dptr)
 Called when a new datablock is set.
 DECLARE_CONOBJECT (FireballAtmosphere)

Static Public Member Functions

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

Protected Member Functions

bool onAdd ()
 Called when the object is added to the sim.
void onRemove ()
 Called when the object is removed from the sim.
void advanceTime (F32 dt)
 Advances simulation time for animations.
void dropNewFireball ()
bool prepRenderImage (SceneState *, const U32, const U32, const bool)
 Called when the SceneGraph is ready for the registration of RenderImages.
void renderObject (SceneState *, SceneRenderImage *)
 Called when the object is supposed to render itself.
U32 packUpdate (NetConnection *, U32 mask, BitStream *stream)
 Instructs this object to pack its state for transfer over the network.
void unpackUpdate (NetConnection *, BitStream *stream)
 Instructs this object to read state data previously packed with packUpdate.

Private Types

typedef GameBase Parent

Private Attributes

FireballAtmosphereDatamDataBlock
AUDIOHANDLE mAudioHandle
F32 mTimeSinceLastDrop
F32 mDropRadius
F32 mDropsPerMinute
F32 mMinDropAngle
F32 mMaxDropAngle
F32 mStartVelocity
F32 mDropHeight
VectorF mDropDir

Member Typedef Documentation

Reimplemented from GameBase.


Constructor & Destructor Documentation

FireballAtmosphere::FireballAtmosphere (  ) 


Member Function Documentation

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

Called when the object is added to the sim.

Reimplemented from GameBase.

void FireballAtmosphere::onRemove (  )  [protected, virtual]

Called when the object is removed from the sim.

Reimplemented from GameBase.

void FireballAtmosphere::advanceTime ( F32  dt  )  [protected, virtual]

Advances simulation time for animations.

This is called every frame.

Parameters:
dt Time since last advance call

Reimplemented from GameBase.

void FireballAtmosphere::dropNewFireball (  )  [protected]

bool FireballAtmosphere::prepRenderImage ( SceneState state,
const   stateKey,
const   startZone,
const   modifyBaseZoneState 
) [protected, virtual]

Called when the SceneGraph is ready for the registration of RenderImages.

See also:
SceneState
Parameters:
state SceneState
stateKey State key of the current SceneState
startZone Base zone index
modifyBaseZoneState If true, the object needs to modify the zone state.

Reimplemented from SceneObject.

void FireballAtmosphere::renderObject ( SceneState state,
SceneRenderImage image 
) [protected, virtual]

Called when the object is supposed to render itself.

Parameters:
state Current rendering state.
See also:
SceneState
Parameters:
image Image associated with this object to render.
See also:
SceneRenderImage

Reimplemented from SceneObject.

U32 FireballAtmosphere::packUpdate ( NetConnection conn,
U32  mask,
BitStream stream 
) [protected, virtual]

Instructs this object to pack its state for transfer over the network.

Parameters:
conn Net connection being used
mask Mask indicating fields to transmit.
stream Bitstream to pack data to
Returns:
Any bits which were not dealt with. The value is stored by the networking system. Don't set bits you weren't passed.

Reimplemented from GameBase.

void FireballAtmosphere::unpackUpdate ( NetConnection conn,
BitStream stream 
) [protected, virtual]

Instructs this object to read state data previously packed with packUpdate.

Parameters:
conn Net connection being used
stream stream to read from

Reimplemented from GameBase.

bool FireballAtmosphere::onNewDataBlock ( GameBaseData dptr  )  [virtual]

Called when a new datablock is set.

This allows subclasses to appropriately handle new datablocks.

See also:
setDataBlock()
Parameters:
dptr New datablock

Reimplemented from GameBase.

static void FireballAtmosphere::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GameBase.

FireballAtmosphere::DECLARE_CONOBJECT ( FireballAtmosphere   ) 


Field Documentation




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