GetSoundPitch

From Onset Developer Wiki
Revision as of 18:32, 11 April 2020 by 28days (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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