GetSoundVolume: Difference between revisions

Revision as of 20:55, 26 December 2008

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

float getSoundVolume ( element theSound )

Returns a float representing the volume level of the sound element, false if invalid arguments were passed.

TODO

Click to collapse [-]

Client

--TODO

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-Gets a custom sound volume.
+This function is used to return the volume level of the specified [[sound]] element.
 ==Syntax==
-<syntaxhighlight lang="lua">float getSoundVolume ( element sound )</syntaxhighlight>
+<syntaxhighlight lang="lua">float getSoundVolume ( element theSound )</syntaxhighlight>
 ===Required Arguments===
-*'''sound:''' a sound element.
+*'''theSound:''' The [[sound]] element which volume you want to return.
 ===Returns===
-Returns a ''float'' of the sound volume, ''false'' if invalid arguements where passed.
+Returns a [[float]] representing the volume level of the [[sound]] element, ''false'' if invalid arguments were passed.
 ==Example==