SetSoundFadeOut: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetSoundFadeOut(sound, Duration, VolumeLevel)}} {{FuncParameters}} {{FuncParam|sound|__EDIT_ME__}}...")
 
No edit summary
 
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Set the sound to fade out.}}


{{FuncSyntax|SetSoundFadeOut(sound, Duration, VolumeLevel)}}
{{FuncSyntax|SetSoundFadeOut(sound, Duration, VolumeLevel)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|sound|__EDIT_ME__}}
{{FuncParam|sound|The sound identifier.}}
{{FuncParam|Duration|__EDIT_ME__}}
{{FuncParam|Duration|The duration of the fade out effect.}}
{{FuncParam|VolumeLevel|__EDIT_ME__}}
{{FuncParam|VolumeLevel|The volume for the sound to fade to.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success, '''false''' on error.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
SetSoundFadeIn(soundId, 1000, 0)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{SoundFunctions}}

Latest revision as of 19:33, 31 December 2019

SetSoundFadeOut

Type: Function
Context: Client
Introduced: v1.0

Description

Set the sound to fade out.

Syntax

SetSoundFadeOut(sound, Duration, VolumeLevel)

Parameters

  • sound
    The sound identifier.
  • Duration
    The duration of the fade out effect.
  • VolumeLevel
    The volume for the sound to fade to.

Return Value

  • Returns true on success, false on error.

Example

SetSoundFadeIn(soundId, 1000, 0)

See also