SetSoundVolume: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
(25 intermediate revisions by 14 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
Sets custom sound volume.
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==  
==Syntax==  
<syntaxhighlight lang="lua">bool setSoundVolume ( element sound, float volume )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound/thePlayer, float volume )</syntaxhighlight>  
 
{{OOP||[[sound]]:setVolume|volume|getSoundVolume}}
===Required Arguments===  
===Required Arguments===  
*'''sound:''' a sound element.
*'''theSound:''' The [[sound]] [[element]] which volume you want to modify or a [[player]] element which voice volume you want to modify.
*'''volume:''' A float representing the desired volume.
*'''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===
Returns ''true'' if the sound volume was successfully changed, ''false'' otherwise.
Returns ''true'' if the [[sound]] [[element]] volume was successfully changed, ''false'' otherwise.


==Example==  
==Example==  
TODO
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
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
</syntaxhighlight>
</syntaxhighlight>
</section>
 
==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element for voice control}}


==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[hu: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"