SetSoundVolume: Difference between revisions

Revision as of 13:23, 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.

bool setSoundVolume ( element theSound, float volume )

OOP Syntax Help! I don't understand this!

Method: sound:setVolume(...)

Variable: .volume

Counterpart: getSoundVolume

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 true if the sound element volume was successfully changed, false otherwise.

Version	Description

1.3.2

Added player element for voice control

@@ Line 15: / Line 15: @@
 ==Example==
-<section name="Client" class="client" show="true">
+<section name="Client" addEventHandler("onClientGUIScroll",ScrollName,
-<syntaxhighlight lang="lua">
+function( )
-function wasted (killer, weapon, bodypart)
+  local Scroll = guiScrollBarGetScrollPosition(ScrollName)
-        local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
+  Volume = Scroll / 100
-        setSoundVolume(sound, 0.5) -- set the sound volume to 50%
+if not isElement( iSound ) then
-end
+    return
+  end
-addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
+  setSoundVolume(iSound,Volume)
+end,false
+)
 </syntaxhighlight>
 </section>