SetSoundVolume: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
Sets custom sound volume.
This function is used to change the volume level of the specified [[sound]] element.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool setSoundVolume ( element sound, float volume )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>  


===Required Arguments===  
===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===
Returns ''true'' if the sound volume was successfully changed, ''false'' otherwise.
Returns ''true'' if the [[sound]] element volume was successfully changed, ''false'' otherwise.


==Example==  
==Example==  

Revision as of 20:54, 26 December 2008

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

Syntax

bool setSoundVolume ( element theSound, float volume )

Required Arguments

  • theSound: The sound element which volume you want to modify.
  • volume: A floating point number representing the desired volume level.

Returns

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

Example

TODO

Click to collapse [-]
Client
--TODO

See Also