IsValidSound: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|IsValidSound(sound)}} {{FuncParameters}} {{FuncParam|sound|__EDIT_ME__}} {{FuncReturnValue|__EDIT...")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Checks whether the sound is valid or not.}}


{{FuncSyntax|IsValidSound(sound)}}
{{FuncSyntax|IsValidSound(sound)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|sound|__EDIT_ME__}}
{{FuncParam|sound|The sound identifier}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' if the sound is valid, otherwise '''false'''.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
if IsValidSound(soundId) then
    DeleteSound(soundId)
end
</syntaxhighlight>


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

Latest revision as of 09:23, 14 December 2019

IsValidSound

Type: Function
Context: Client
Introduced: v1.0

Description

Checks whether the sound is valid or not.

Syntax

IsValidSound(sound)

Parameters

  • sound
    The sound identifier

Return Value

  • Returns true if the sound is valid, otherwise false.

Example

if IsValidSound(soundId) then
    DeleteSound(soundId)
end

See also