SetVolume

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 14:45, 12 March 2013 by AFRLme (talk)

Command History

Available since v3.7
MovieVolume & GlobalVolume added to v3.8


Allows the user to set volume levels of: music, sound fx, speech, movies & global(master)

Additional Info

These are the numbers used inside of the setVolume(brackets) to set specific volume types!
eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4)


Syntax:

setVolume(type, volume)


Example 1: basic set volume

-- set music volume to 50%!
setVolume(0, 50)

-- set sound fx volume to 50%!
setVolume(1, 50)

-- set speech volume to 50%!
setVolume(2, 50)

-- set movie volume to 50%!
setVolume(3, 50)

-- set global (master) volume to 50%!
setVolume(4, 50)


Arguments

type: integer (number)
The type of volume to set: eMusicVolume (0), eSoundVolume (1), eSpeechVolume (2), eMovieVolume (3) or eGlobalVolume (4)

volume: integer (number)
New value for volume. Must be a value between 0 and 100


Flags

none


Return

none


Relevant Pages: getVolume