Murl Engine Lua Addon API  Version 1.0 beta
Murl.Logic.SoundFader

Animation class for fading the volume of a GraphSoundObject.


Table members

Inherited


Murl.Logic.Animation.Real

Functions


Murl.Logic.SoundFader.new()

Create a SoundFader object.

Murl.SharedPointer.LogicSoundFader new()

Returns
Murl.SharedPointer.LogicSoundFader The SoundFader shared pointer.

Murl.Logic.SoundFader.new(soundObject)

Create a SoundFader object taking a GraphSoundObject. Use Logic::GraphSoundObject::Create() to create the shared pointer.

Murl.SharedPointer.LogicSoundFader new(Murl.SharedPointer.LogicGraphSoundObject soundObject)

Parameters
soundObjectThe GraphSoundObject shared pointer.
Returns
Murl.SharedPointer.LogicSoundFader The SoundFader shared pointer.

Murl.Logic.SoundFader.Create()

Create a SoundFader object.

Murl.SharedPointer.LogicSoundFader Create()

Returns
Murl.SharedPointer.LogicSoundFader The SoundFader shared pointer.

Murl.Logic.SoundFader.Create(soundObject)

Create a SoundFader object taking a GraphSoundObject. Use Logic::GraphSoundObject::Create() to create the shared pointer.

Murl.SharedPointer.LogicSoundFader Create(Murl.SharedPointer.LogicGraphSoundObject soundObject)

Parameters
soundObjectThe GraphSoundObject shared pointer.
Returns
Murl.SharedPointer.LogicSoundFader The SoundFader shared pointer.


Methods


Init(nodeObserver, namespaceNode, timelinePath, sequencePath, index)

Initialize the object.

Boolean Init(Murl.Logic.INodeObserver nodeObserver, Murl.Graph.INamespace namespaceNode, String timelinePath, String sequencePath, Integer index)

Parameters
nodeObserverThe INodeObserver object.
namespaceNodeThe logic namespace node.
timelinePathThe full path to the graph timeline node instance.
sequencePathThe full path to the graph audio sequence node instance.
indexThe index of the instance.
Returns
Boolean true if successful.

Init(nodeObserver, root, timelinePath, sequencePath, index)

Initialize the object.

Boolean Init(Murl.Logic.INodeObserver nodeObserver, Murl.Graph.IRoot root, String timelinePath, String sequencePath, Integer index)

Parameters
nodeObserverThe INodeObserver object.
rootThe graph root node.
timelinePathThe full path to the graph timeline node instance.
sequencePathThe full path to the graph audio sequence node instance.
indexThe index of the instance.
Returns
Boolean true if successful.

DeInit()

Deinitialize the object.

Boolean DeInit()

Returns
Boolean true if successful.

FadeIn(resume)

Start and fade in the sound.

FadeIn(Boolean resume)

Parameters
resumeIf true resume playing the sound, otherwise restart the sound.

FadeOut(pause)

Fade out the sound.

FadeOut(Boolean pause)

Parameters
pauseIf true pause the sound after fade out, otherwise stop the sound.

SetDuration(duration)

Set the fading duration.

Boolean SetDuration(Number duration)

Parameters
durationThe fading duration in seconds.
Returns
Boolean true if successful.

GetDuration()

Get the fading duration.

Number GetDuration()

Returns
Number The fading duration in seconds.

SetStartVolume(volume)

Set the start volume.

Boolean SetStartVolume(Number volume)

Parameters
volumeThe volume in range [0.0 .. 1.0].
Returns
Boolean true if successful.

SetEndVolume(volume)

Set the end volume.

Boolean SetEndVolume(Number volume)

Parameters
volumeThe volume in range [0.0 .. 1.0].
Returns
Boolean true if successful.

SetVolume(startVolume, endVolume)

Set the start and end volume.

Boolean SetVolume(Number startVolume, Number endVolume)

Parameters
startVolumeThe start volume in range [0.0 .. 1.0].
endVolumeThe end volume in range [0.0 .. 1.0].
Returns
Boolean true if successful.

GetStartVolume()

Get the start volume.

Number GetStartVolume()

Returns
Number The start volume.

GetEndVolume()

Get the end volume.

Number GetEndVolume()

Returns
Number The end volume.

Reset()

Overwrite of the Animation::Reset() method. Reset the animation and stop playing.

Reset()



Instance Members


mSound

The GraphSoundObject shared pointer.

Returns
Murl.SharedPointer.LogicGraphSoundObject