SetSoundVolume: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
(11 intermediate revisions by 8 users not shown)
Line 5: Line 5:


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound/thePlayer, float volume )</syntaxhighlight>  
{{OOP||[[sound]]:setVolume|volume|getSoundVolume}}
{{OOP||[[sound]]:setVolume|volume|getSoundVolume}}
===Required Arguments===  
===Required Arguments===  
*'''theSound:''' The [[sound]] [[element]] which volume you want to modify.
*'''theSound:''' The [[sound]] [[element]] which volume you want to modify or a [[player]] element which voice volume you want to modify.
*'''volume:''' A [[float]]ing point number representing the desired volume level. Range is from '''0.0''' to '''1.0'''
*'''volume:''' A [[float]]ing 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===
Line 15: Line 15:


==Example==  
==Example==  
<syntaxhighlight lang="lua">="addEventHandler("onClientGUIScroll",ScrollName,
<syntaxhighlight lang="lua">
function( )
function wasted (killer, weapon, bodypart)
  local Scroll = guiScrollBarGetScrollPosition(ScrollName)
        local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
  Volume = Scroll / 100
        setSoundVolume(sound, 0.5) -- set the sound volume to 50%
if not isElement( iSound ) then
end
    return
 
  end
addEventHandler("onClientPlayerWasted", localPlayer, wasted) --add the event handler
  setSoundVolume(iSound,Volume)
</syntaxhighlight>
end,false
) </syntaxhighlight>


==Changelog==
==Changelog==
Line 32: Line 30:
==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[hu:setSoundVolume]]
[[AR:setSoundVolume]]
[[AR:setSoundVolume]]
[[RO:setSoundVolume]]

Latest revision as of 03:40, 13 March 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/thePlayer, 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 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

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

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