SetSoundFadeIn: Difference between revisions
From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetSoundFadeIn(sound [, Duration, VolumeLevel, StartTime])}} {{FuncParameters}} {{FuncParam|sound...") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Info|Function|Client|1.0}} | {{Info|Function|Client|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Set the sound to fade in.}} | ||
{{FuncSyntax|SetSoundFadeIn(sound [, Duration, VolumeLevel, StartTime])}} | {{FuncSyntax|SetSoundFadeIn(sound [, Duration, VolumeLevel, StartTime])}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|sound | | {{FuncParam|sound |The sound identifier.}} | ||
{{FuncParam|Duration| | {{FuncParam|Duration|The duration of the fade in effect.}} | ||
{{FuncParam|VolumeLevel| | {{FuncParam|VolumeLevel|The volume for the sound to fade to.}} | ||
{{FuncParamOptional|StartTime| | {{FuncParamOptional|StartTime|The duration after which you need the effect to take place.}} | ||
{{FuncReturnValue| | {{FuncReturnValue|Returns '''true''' on success, '''false''' on error.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua"> | |||
SetSoundFadeIn(soundId, 1000, 0, 2000) | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{SoundFunctions}} | |||
Latest revision as of 19:32, 31 December 2019
Description
Set the sound to fade in.
Syntax
SetSoundFadeIn(sound [, Duration, VolumeLevel, StartTime])
Parameters
- sound
The sound identifier. - Duration
The duration of the fade in effect. - VolumeLevel
The volume for the sound to fade to. - StartTime (optional)
The duration after which you need the effect to take place.
Return Value
- Returns true on success, false on error.
Example
SetSoundFadeIn(soundId, 1000, 0, 2000)
