SFXFadeModifier

Inheritance diagram for SFXFadeModifier ↕

A volume fade effect (fade-in or fade-out).

Public Types

enum

EOnEnd {
  ON_END_Nop 
  ON_END_Stop 
  ON_END_Pause 
}

SFXRangeModifier

Parent

F32

mCurrentVolume

Current volume level.

F32

mEndVolume

Volume when ending fade.

EOnEnd

mOnEnd

Action to perform when the fade has been completed. Defaults to no action.

F32

mStartVolume

Volume when beginning fade. Set when effect is activated.

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.

SFXFadeModifier(SFXSource * source, F32 time, F32 endVolume, F32 startTime, EOnEnd onEndDo, bool removeWhenDone)

Create an effect that fades the volume of "source" to "endVolume" over the period of "time" seconds.

~SFXFadeModifier()

A volume fade effect (fade-in or fade-out).

EOnEnd

typedef SFXRangeModifier Parent

F32 mCurrentVolume

Current volume level.

F32 mEndVolume

Volume when ending fade.

EOnEnd mOnEnd

Action to perform when the fade has been completed. Defaults to no action.

F32 mStartVolume

Volume when beginning fade. Set when effect is activated.

_onEnd()

Reimplemented from: SFXRangeModifier

_onStart()

Reimplemented from: SFXRangeModifier

_onUpdate()

Reimplemented from: SFXRangeModifier

SFXFadeModifier(SFXSource * source, F32 time, F32 endVolume, F32 startTime, EOnEnd onEndDo, bool removeWhenDone)

Create an effect that fades the volume of "source" to "endVolume" over the period of "time" seconds.

The fade will start at "referenceTime" using the source's current volume at the time as the start.

~SFXFadeModifier()