GetSoundPitch

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.
GetSoundPitch

Type: Function
Context: Client
Introduced: v1.0

Description

Gets the sound pitch.

Syntax

GetSoundPitch(sound)

Parameters

  • sound
    The sound identifier.

Return Value

  • Returns pitch in floating point on success, false on error.

Example

local pitch = GetSoundPitch(soundId)
if (pitch == false) then
    -- the sound ID is not valid
else
    -- the sound ID pitch is now stored in the variable pitch for use
end

See also