SetSoundPitch

From Onset Developer Wiki
Revision as of 21:34, 27 October 2020 by BlueMountains (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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