Difference between revisions of "SetSoundVolume"

From Multi Theft Auto: Wiki
(Added amplification info)
m
Line 32: Line 32:
 
[[hu:setSoundVolume]]
 
[[hu:setSoundVolume]]
 
[[AR:setSoundVolume]]
 
[[AR:setSoundVolume]]
 +
[[RO:setSoundVolume]]

Revision as of 19:37, 30 January 2019

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. This can go above 1.0 for amplification.

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", localPlayer, wasted) --add the event handler 

Changelog

Version Description
1.3.2 Added player element for voice control

See Also