SetSoundVolume: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Undo revision 44685 by MFGRHOM (talk) Vandalism)
(removed unnecessary section)
Line 15: Line 15:


==Example==  
==Example==  
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
function wasted (killer, weapon, bodypart)
Line 24: Line 23:
addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler  
addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler  
</syntaxhighlight>
</syntaxhighlight>
</section>


==Changelog==
==Changelog==

Revision as of 19:14, 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

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

See Also