Torque3D Documentation / _generateds / SFXRangeModifier

SFXRangeModifier

Engine/source/sfx/sfxModifier.h

An SFXModifier that is spans a certain range of playback time.

More...

Public Types

SFXModifier

Parent

Protected Attributes

F32

mEndTime

Playback position in milliseconds when this effect becomes inactive.

bool

mIsActive

If true, the effect is currently being applied to the source.

F32

mStartTime

Playback position in milliseconds when this effect becomes active.

Protected Functions

void

_onEnd()

Called when the play cursor passes mEndTime.

void

_onStart()

Called when the play cursor passes mStartTime.

void

_onUpdate()

Called on each update() while the play cursor is in range.

Public Functions

SFXRangeModifier(SFXSource * source, F32 startTime, F32 endTime, bool removeWhenDone)

Create an effect that operates on "source" between "startTime" seconds (inclusive) and "endTime" seconds (exclusive).
bool

isActive()

bool

update()

Update the object state.
Detailed Description
An SFXModifier that is spans a certain range of playback time.
Public Types
typedef SFXModifier Parent 

Protected Attributes
F32 mEndTime 

Playback position in milliseconds when this effect becomes inactive.
bool mIsActive 

If true, the effect is currently being applied to the source.
F32 mStartTime 

Playback position in milliseconds when this effect becomes active.
Protected Functions
_onEnd()

Called when the play cursor passes mEndTime.
note:
There may be latency between the cursor actually passing mEndTime and this method being called.
Reimplemented by: SFXFadeModifier
_onStart()

Called when the play cursor passes mStartTime.
note:
There may be latency between the cursor actually passing mStartTime and this method being called.
Reimplemented by: SFXFadeModifier
_onUpdate()

Called on each update() while the play cursor is in range.
Reimplemented by: SFXFadeModifier
Public Functions
SFXRangeModifier(SFXSource * source, F32 startTime, F32 endTime, bool removeWhenDone)

Create an effect that operates on "source" between "startTime" seconds (inclusive) and "endTime" seconds (exclusive).
isActive()

update()

Reimplemented from: IPolled