DamageInfoInput Class Reference

#include <Damage.h>

Inherits Snapshot.

Public Member Functions
	DamageInfoInput (void)
Public Member Functions inherited from Snapshot
	Snapshot (void)
	~Snapshot (void)

Public Attributes
ObjectID	m_sourceID
	source of the damage
const ThingTemplate *	m_sourceTemplate
	source of the damage (the template).
PlayerMaskType	m_sourcePlayerMask
	Player mask of m_sourceID.
DamageType	m_damageType
	type of damage
ObjectStatusTypes	m_damageStatusType
	If status damage, what type.
DamageType	m_damageFXOverride
	If not marked as the default of Unresistable, the damage type to use in doDamageFX instead of the real damamge type.
DeathType	m_deathType
	if this kills us, death type to be used
Real	m_amount
Bool	m_kill
	will always cause object to die regardless of damage.
Coord3D	m_shockWaveVector
	This represents the incoming damage vector.
Real	m_shockWaveAmount
	This represents the amount of shockwave created by the damage. 0 = no shockwave, 1.0 = shockwave equal to damage.
Real	m_shockWaveRadius
	This represents the effect radius of the shockwave.
Real	m_shockWaveTaperOff
	This represents the taper off effect of the shockwave at the tip of the radius. 0.0 means shockwave is 0% at the radius edge.

Protected Member Functions
virtual void	crc (Xfer *xfer)
	run the "light" crc check on this data structure
virtual void	xfer (Xfer *xfer)
virtual void	loadPostProcess (void)

Detailed Description

Damage info inputs

Definition at line 257 of file Damage.h.

Constructor & Destructor Documentation

DamageInfoInput()

DamageInfoInput::DamageInfoInput ( void )

inline

Definition at line 262 of file Damage.h.

Member Function Documentation

crc()

virtual void DamageInfoInput::crc ( Xfer * xfer )

inlineprotectedvirtual

run the "light" crc check on this data structure

Implements Snapshot.

Definition at line 300 of file Damage.h.

loadPostProcess()

virtual void DamageInfoInput::loadPostProcess ( void )

inlineprotectedvirtual

post process phase for loading save games. All save systems have their xfer run using XferLoad mode, and then all systems each have their post process run

Implements Snapshot.

Definition at line 302 of file Damage.h.

xfer()

void DamageInfoInput::xfer ( Xfer * xfer )

protectedvirtual

Xfer method Version Info: 1: Initial version 2: Damage FX override

Implements Snapshot.

Definition at line 122 of file Damage.cpp.

Member Data Documentation

m_amount

Real DamageInfoInput::m_amount

value of how much damage to inflict

Definition at line 287 of file Damage.h.

m_damageFXOverride

DamageType DamageInfoInput::m_damageFXOverride

If not marked as the default of Unresistable, the damage type to use in doDamageFX instead of the real damamge type.

Definition at line 285 of file Damage.h.

m_damageStatusType

ObjectStatusTypes DamageInfoInput::m_damageStatusType

If status damage, what type.

Definition at line 284 of file Damage.h.

m_damageType

DamageType DamageInfoInput::m_damageType

type of damage

Definition at line 283 of file Damage.h.

m_deathType

DeathType DamageInfoInput::m_deathType

if this kills us, death type to be used

Definition at line 286 of file Damage.h.

m_kill

Bool DamageInfoInput::m_kill

will always cause object to die regardless of damage.

Definition at line 288 of file Damage.h.

m_shockWaveAmount

Real DamageInfoInput::m_shockWaveAmount

This represents the amount of shockwave created by the damage. 0 = no shockwave, 1.0 = shockwave equal to damage.

Definition at line 292 of file Damage.h.

m_shockWaveRadius

Real DamageInfoInput::m_shockWaveRadius

This represents the effect radius of the shockwave.

Definition at line 293 of file Damage.h.

m_shockWaveTaperOff

Real DamageInfoInput::m_shockWaveTaperOff

This represents the taper off effect of the shockwave at the tip of the radius. 0.0 means shockwave is 0% at the radius edge.

Definition at line 294 of file Damage.h.

m_shockWaveVector

Coord3D DamageInfoInput::m_shockWaveVector

This represents the incoming damage vector.

Definition at line 291 of file Damage.h.

m_sourceID

ObjectID DamageInfoInput::m_sourceID

source of the damage

Definition at line 280 of file Damage.h.

m_sourcePlayerMask

PlayerMaskType DamageInfoInput::m_sourcePlayerMask

Player mask of m_sourceID.

Definition at line 282 of file Damage.h.

m_sourceTemplate

const ThingTemplate* DamageInfoInput::m_sourceTemplate

source of the damage (the template).

Definition at line 281 of file Damage.h.

---

The documentation for this class was generated from the following files:

• Code/GameEngine/Include/GameLogic/Damage.h
• Code/GameEngine/Source/GameLogic/System/Damage.cpp