![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
Animation class for fading the volume of a GraphSoundObject.
Create a SoundFader object.
Murl.SharedPointer.LogicSoundFader new()
Create a SoundFader object taking a GraphSoundObject. Use Logic::GraphSoundObject::Create() to create the shared pointer.
Murl.SharedPointer.LogicSoundFader new(Murl.SharedPointer.LogicGraphSoundObject soundObject)
soundObject | The GraphSoundObject shared pointer. |
Create a SoundFader object.
Murl.SharedPointer.LogicSoundFader Create()
Create a SoundFader object taking a GraphSoundObject. Use Logic::GraphSoundObject::Create() to create the shared pointer.
Murl.SharedPointer.LogicSoundFader Create(Murl.SharedPointer.LogicGraphSoundObject soundObject)
soundObject | The GraphSoundObject shared pointer. |
Initialize the object.
Boolean Init(Murl.Logic.INodeObserver nodeObserver, Murl.Graph.INamespace namespaceNode, String timelinePath, String sequencePath, Integer index)
nodeObserver | The INodeObserver object. |
namespaceNode | The logic namespace node. |
timelinePath | The full path to the graph timeline node instance. |
sequencePath | The full path to the graph audio sequence node instance. |
index | The index of the instance. |
Initialize the object.
Boolean Init(Murl.Logic.INodeObserver nodeObserver, Murl.Graph.IRoot root, String timelinePath, String sequencePath, Integer index)
nodeObserver | The INodeObserver object. |
root | The graph root node. |
timelinePath | The full path to the graph timeline node instance. |
sequencePath | The full path to the graph audio sequence node instance. |
index | The index of the instance. |
Deinitialize the object.
Boolean DeInit()
Start and fade in the sound.
FadeIn(Boolean resume)
resume | If true resume playing the sound, otherwise restart the sound. |
Fade out the sound.
FadeOut(Boolean pause)
pause | If true pause the sound after fade out, otherwise stop the sound. |
Set the fading duration.
Boolean SetDuration(Number duration)
duration | The fading duration in seconds. |
Get the fading duration.
Number GetDuration()
Set the start volume.
Boolean SetStartVolume(Number volume)
volume | The volume in range [0.0 .. 1.0]. |
Set the end volume.
Boolean SetEndVolume(Number volume)
volume | The volume in range [0.0 .. 1.0]. |
Set the start and end volume.
Boolean SetVolume(Number startVolume, Number endVolume)
startVolume | The start volume in range [0.0 .. 1.0]. |
endVolume | The end volume in range [0.0 .. 1.0]. |
Get the start volume.
Number GetStartVolume()
Get the end volume.
Number GetEndVolume()
Overwrite of the Animation::Reset() method. Reset the animation and stop playing.
Reset()
The GraphSoundObject shared pointer.