Torque3D Documentation / _generateds / SFXPlayList::SlotData

SFXPlayList::SlotData

Engine/source/sfx/sfxPlayList.h

Settings for the playback slots.

More...

Public Attributes

Time to delay before mTransitionIn.

Time to delay before mTransitionOut.

Seconds to fade sound in. -1 to leave at default.

Seconds to fade sound out. -1 to leave at default.

Max distance for 3D sounds.

Min distance for 3D sounds.

Pitch scale factor.

mRepeatCount [NUM_SLOTS]

Number of times to loop over this slot.

mReplayMode [NUM_SLOTS]

Behavior when a sound is already playing on a slot from a previous cycle.

mState [NUM_SLOTS]

State restriction for this slot.

mStateMode [NUM_SLOTS]

Bahavior when state of this slot is deactivated and the slot's track is playing.

mTrack [NUM_SLOTS]

Track to play in this slot.

mTransitionIn [NUM_SLOTS]

Behavior when transitioning into the slot.

mTransitionOut [NUM_SLOTS]

Behavior when transitioning out of the slot.

Volume scale factor.

Public Functions

Detailed Description

Settings for the playback slots.

Public Attributes

VariantFloat mDelayTimeIn 

Time to delay before mTransitionIn.

VariantFloat mDelayTimeOut 

Time to delay before mTransitionOut.

VariantFloat mFadeTimeIn 

Seconds to fade sound in. -1 to leave at default.

VariantFloat mFadeTimeOut 

Seconds to fade sound out. -1 to leave at default.

VariantFloat mMaxDistance 

Max distance for 3D sounds.

VariantFloat mMinDistance 

Min distance for 3D sounds.

VariantFloat mPitchScale 

Pitch scale factor.

U32 mRepeatCount [NUM_SLOTS]

Number of times to loop over this slot.

note:

Each iteration will do a full transition as if proceeding to a different slot.

EReplayMode mReplayMode [NUM_SLOTS]

Behavior when a sound is already playing on a slot from a previous cycle.

SFXState * mState [NUM_SLOTS]

State restriction for this slot.

Slot will only play when the given state is active and will be automatically transitioned from if the state becomes inactive.

EStateMode mStateMode [NUM_SLOTS]

Bahavior when state of this slot is deactivated and the slot's track is playing.

SFXTrack * mTrack [NUM_SLOTS]

Track to play in this slot.

ETransitionMode mTransitionIn [NUM_SLOTS]

Behavior when transitioning into the slot.

ETransitionMode mTransitionOut [NUM_SLOTS]

Behavior when transitioning out of the slot.

VariantFloat mVolumeScale 

Volume scale factor.

Public Functions

SlotData()