Torque Game Engine Documentation
TGE Version 1.5.2

ShapeBaseData Struct Reference

#include <shapeBase.h>

Inheritance diagram for ShapeBaseData:


HUD
Note: This may be only semi-functional.
enum	{ NumHudRenderImages = 8 }
StringTableEntry	hudImageNameFriendly [NumHudRenderImages]
StringTableEntry	hudImageNameEnemy [NumHudRenderImages]
TextureHandle	hudImageFriendly [NumHudRenderImages]
TextureHandle	hudImageEnemy [NumHudRenderImages]
bool	hudRenderCenter [NumHudRenderImages]
bool	hudRenderModulated [NumHudRenderImages]
bool	hudRenderAlways [NumHudRenderImages]
bool	hudRenderDistance [NumHudRenderImages]
bool	hudRenderName [NumHudRenderImages]
Destruction
Everyone likes to blow things up!
DebrisData *	debris
S32	debrisID
StringTableEntry	debrisShapeName
Resource< TSShape >	debrisShape
ExplosionData *	explosion
S32	explosionID
ExplosionData *	underwaterExplosion
S32	underwaterExplosionID
Physical Properties
F32	mass
F32	drag
F32	density
F32	maxEnergy
F32	maxDamage
F32	repairRate
	Rate per tick.
F32	disabledLevel
F32	destroyedLevel
S32	shieldEffectLifetimeMS
3rd Person Camera
F32	cameraMaxDist
	Maximum distance from eye.
F32	cameraMinDist
	Minumumistance from eye.
Camera FOV
These are specified in degrees.
F32	cameraDefaultFov
	Default FOV.
F32	cameraMinFov
	Min FOV allowed.
F32	cameraMaxFov
	Max FOV allowed.
Data initialized on preload
Resource< TSShape >	shape
	Shape handle.
U32	mCRC
bool	computeCRC
S32	eyeNode
	Shape's eye node index.
S32	cameraNode
	Shape's camera node index.
S32	shadowNode
	Move shadow center as this node moves.
S32	mountPointNode [NumMountPoints]
	Node index of mountPoint.
S32	debrisDetail
	Detail level used to generate debris.
S32	damageSequence
	Damage level decals.
S32	hulkSequence
	Destroyed hulk.
bool	canControl
bool	canObserve
bool	observeThroughObject
Collision Data
Vector< S32 >	collisionDetails
	Detail level used to collide with.
Vector< Box3F >	collisionBounds
	Detail level bounding boxes.
Vector< S32 >	LOSDetails
	Detail level used to perform line-of-sight queries against.
Shadow Settings
These are set by derived classes, not by script file. They control when shadows are rendered (and when generic shadows are substituted)
F32	genericShadowLevel
F32	noShadowLevel
Misc. Settings
bool	emap
	Enable environment mapping?
bool	firstPersonOnly
	Do we allow only first person view of this image?
bool	useEyePoint
	Do we use this object's eye point to view from?
bool	aiAvoidThis
	If set, the AI's will try to walk around this object.
bool	isInvincible
	If set, object cannot take damage (won't show up with damage bar either).
bool	renderWhenDestroyed
	If set, will not render this object when destroyed.
bool	inheritEnergyFromMount
Infrastructure
The derived class should provide the following:
	DECLARE_CONOBJECT (ShapeBaseData)
	ShapeBaseData ()
	~ShapeBaseData ()
virtual void	packData (BitStream *stream)
virtual void	unpackData (BitStream *stream)
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Public Types
enum	Constants { NumMountPoints = 32, NumMountPointBits = 5, MaxCollisionShapes = 8, AIRepairNode = 31 }
	Various constants relating to the ShapeBaseData. More...
Public Member Functions
bool	preload (bool server, char errorBuffer[256])
	Called to prepare the datablock for use, after it has been unpacked.
void	computeAccelerator (U32 i)
S32	findMountPoint (U32 n)
Data Fields
bool	shadowEnable
bool	shadowCanMove
bool	shadowCanAnimate
StringTableEntry	shapeName
StringTableEntry	cloakTexName
Private Types
typedef GameBaseData	Parent

Member Typedef Documentation

typedef GameBaseData ShapeBaseData::Parent [private]

Reimplemented from GameBaseData.

Reimplemented in CameraData, ItemData, MissionMarkerData, PathCameraData, PlayerData, RigidShapeData, StaticShapeData, FlyingVehicleData, HoverVehicleData, VehicleData, and WheeledVehicleData.

Member Enumeration Documentation

enum ShapeBaseData::Constants

Various constants relating to the ShapeBaseData.

Enumerator:

NumMountPoints
NumMountPointBits
MaxCollisionShapes
AIRepairNode

Reimplemented in PlayerData, and WheeledVehicleData.

anonymous enum

Enumerator:

NumHudRenderImages

Constructor & Destructor Documentation

ShapeBaseData::ShapeBaseData ( )

ShapeBaseData::~ShapeBaseData ( )

Member Function Documentation

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