Torque3D Documentation / _generateds / afxFootSwitchData

afxFootSwitchData

consoledoc.h

A datablock that specifies a Foot Switch effect.

More...

Public Attributes

bool

When true, all of a Player's footstep effects are turned off for the duration of the foot-switch effect.

bool

Specifically selects whether the Player's footprint decals are enabled.

bool

Specifically selects whether the Player's footstep puffs of dust are enabled.

bool

Specifically selects whether the Player's footstep sounds are enabled.

Detailed Description

A datablock that specifies a Foot Switch effect.

A Foot Switch effect is used to disable some or all of the standard built-in footstep effects generated by Player objects.

Stock Player objects generate footprint decals, footstep sounds, and puffs of particle dust in response to special animation triggers embedded in the Player's dts model. With the help of Phase Effects, AFX can substitute alternatives for these built-in effects. When this is done, it is often preferable to turn off some or all of the built-in footstep effects.

Foot Switch effects are only meaningful when the primary position constraint is a Player or Player-derived object.

Public Attributes

bool overrideAll 

When true, all of a Player's footstep effects are turned off for the duration of the foot-switch effect.

bool overrideDecals 

Specifically selects whether the Player's footprint decals are enabled.

bool overrideDust 

Specifically selects whether the Player's footstep puffs of dust are enabled.

bool overrideSounds 

Specifically selects whether the Player's footstep sounds are enabled.