SetSoundVolume: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 15: Line 15:


==Example==  
==Example==  
<section name="Client" addEventHandler("onClientGUIScroll",ScrollName,
<syntaxhighlight lang="lua">="addEventHandler("onClientGUIScroll",ScrollName,
function( )
function( )
   local Scroll = guiScrollBarGetScrollPosition(ScrollName)
   local Scroll = guiScrollBarGetScrollPosition(ScrollName)
Line 25: Line 25:
end,false
end,false
) </syntaxhighlight>
) </syntaxhighlight>
</section>


==Changelog==
==Changelog==

Revision as of 13:25, 17 February 2015

This function is used to change the volume level of the specified sound element. Use a player element to control a players voice with this function.

Syntax

bool setSoundVolume ( element theSound, float volume )

OOP Syntax Help! I don't understand this!

Method: sound:setVolume(...)
Variable: .volume
Counterpart: getSoundVolume


Required Arguments

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

Returns

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

Example

="addEventHandler("onClientGUIScroll",ScrollName,
function( )
  local Scroll = guiScrollBarGetScrollPosition(ScrollName)
  Volume = Scroll / 100
if not isElement( iSound ) then
    return
  end
  setSoundVolume(iSound,Volume)
end,false
)

Changelog

Version Description
1.3.2 Added player element for voice control

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundVolume?oldid=44687"