torque Torque Game Engine Documentation
TGE Version 1.5.2

DecalData Class Reference

#include <decalManager.h>

Inheritance diagram for DecalData:

Inheritance graph
[legend]

Detailed Description

DataBlock implementation for decals.


Public Member Functions

 DecalData ()
 ~DecalData ()
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 (DecalData)

Static Public Member Functions

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

Data Fields

F32 sizeX
F32 sizeY
StringTableEntry textureName
bool selfIlluminated
U32 lifeSpan
TextureHandle textureHandle

Private Types

typedef GameBaseData Parent


Member Typedef Documentation

typedef GameBaseData DecalData::Parent [private]

Reimplemented from GameBaseData.


Constructor & Destructor Documentation

DecalData::DecalData (  ) 

DecalData::~DecalData (  ) 


Member Function Documentation

void DecalData::packData ( BitStream  )  [virtual]

Reimplemented from SimDataBlock.

void DecalData::unpackData ( BitStream  )  [virtual]

Reimplemented from GameBaseData.

bool DecalData::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.

DecalData::DECLARE_CONOBJECT ( DecalData   ) 

static void DecalData::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GameBaseData.


Field Documentation

TextureHandle DecalData::textureHandle




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