View source for RegisterEventHandler

<b>History</b>: Available since <span style="color:green">v3.7</span> <br/>
MovieVolume & GlobalVolume added to <span style="color:green">v3.8</span>

Allows the user to check current volume levels of: music, sound fx, speech, movies & global(master)
{| class="mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
! Additional Info
|-
|
These are the numbers used inside of the getVolume(brackets) to check specific volume types! <br/>
 eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4)
|}

Syntax:
<syntaxhighlight>
getVolume()
</syntaxhighlight>

Example:
<syntaxhighlight>
-- is music volume over 50%?
if getVolume(0) > 50 then
 -- do some action!
end

-- is sound fx volume less than 25%?
if getVolume(1) < 25 then
 -- do some action!
end

-- is speech volume more than or equal to 80%?
if getVolume(2) >= 80 then
 -- do some action!
end

-- is movie volume at 50%?
if getVolume(3) == 50 then
 -- do some action!
end

-- is global (master) volume not equal to 50%?
if getVolume(4) ~= 50 then
 -- do some action!
end
</syntaxhighlight>


<b><u>Arguments</u></b>

type: integer <br/>
The type of volume to return: eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4)

Flags: none

Return: volume <br/>
The queried volume
{{i18n|GetVolume}}