SetSoundVolume: Difference between revisions

Revision as of 20:54, 26 December 2008

This function is used to change the volume level of the specified sound element.

bool setSoundVolume ( element theSound, float volume )

Returns true if the sound element volume was successfully changed, false otherwise.

TODO

Click to collapse [-]

Client

--TODO

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-Sets custom sound volume.
+This function is used to change the volume level of the specified [[sound]] element.
 ==Syntax==
-<syntaxhighlight lang="lua">bool setSoundVolume ( element sound, float volume )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>
 ===Required Arguments===
-*'''sound:''' a sound element.
+*'''theSound:''' The [[sound]] element which volume you want to modify.
-*'''volume:''' A float representing the desired volume.
+*'''volume:''' A floating point number representing the desired volume level.
 ===Returns===
-Returns ''true'' if the sound volume was successfully changed, ''false'' otherwise.
+Returns ''true'' if the [[sound]] element volume was successfully changed, ''false'' otherwise.
 ==Example==