SetSoundPitch: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
Line 7: Line 7:
{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|sound|The sound identifier.}}
{{FuncParam|sound|The sound identifier.}}
{{FuncParam|Pitch|The pitch in floating point.}}
{{FuncParam|Pitch|The pitch in floating point. Between 0 and 10. }}


{{FuncReturnValue|Returns '''true''' on success.}}
{{FuncReturnValue|Returns '''true''' on success.}}

Latest revision as of 21:34, 27 October 2020

SetSoundPitch

Type: Function
Context: Client
Introduced: v1.0

Description

Sets the sound pitch.

Syntax

SetSoundPitch(sound, Pitch)

Parameters

  • sound
    The sound identifier.
  • Pitch
    The pitch in floating point. Between 0 and 10.

Return Value

  • Returns true on success.

Example

if (IsValidSound(soundId)) then
        SetSoundPitch(soundId, 0.5) -- Half the sound pitch
end

See also