SetSoundVolume: Difference between revisions

Revision as of 22:38, 4 May 2013

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 )

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

Click to collapse [-]

Client

function wasted (killer, weapon, bodypart)
        local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
        setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler

Changelog

Version	Description

1.3.2

Added player element for voice control

@@ Line 2: / Line 2: @@
 {{Client function}}
 This function is used to change the volume level of the specified [[sound]] element.
+{{New_feature|3.0139|1.3.2|
+Use a player element to control a players voice with this function.
+}}
 ==Syntax==
 <syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>
@@ Line 24: / Line 26: @@
 </syntaxhighlight>
 </section>
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.2|Added player element for voice control}}
 ==See Also==
 {{Client_audio_functions}}