setSoundVolume | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

setSoundVolume

Client-side
Server-side
Shared

Pair: getSoundVolume

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.

OOP Syntax Help! I don't understand this!

  • Method: sound:getVolume(...)
  • Variable: .volume

Syntax

bool setSoundVolume ( sound/player theSound, float volume )
Required Arguments
  • theSound: The sound element which volume you want to modify or a player element which voice 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

  • bool: result

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

Code Examples

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

Changelog

  • 1.3.2Added player element for voice control.

    • See Also

    Audio Functions
    Audio Elements
    Reference