SetSoundVolume: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:
===Required Arguments===  
===Required Arguments===  
*'''theSound:''' The [[sound]] element which volume you want to modify.
*'''theSound:''' The [[sound]] element which volume you want to modify.
*'''volume:''' A [[float|floating]] point number representing the desired volume level. Range is from 0 - 1
*'''volume:''' A [[float|floating]] point number representing the desired volume level. Range is from '''0.0''' to '''1.0'''


===Returns===
===Returns===

Revision as of 23:58, 14 August 2011

This function is used to change the volume level of the specified sound element.

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

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundVolume?oldid=26701"