SetSoundPitch

From Onset Developer Wiki
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
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