GetSoundVolume: Difference between revisions

Latest revision as of 16:36, 26 September 2021

This function is used to return the volume level of the specified sound element. If the element is a player, this function will use the players voice.

Syntax

float getSoundVolume ( element theSound )

OOP Syntax Help! I don't understand this!

Method: sound:getVolume(...)

Variable: .volume

Counterpart: setSoundVolume

Required Arguments

theSound: the sound element which volume you want to return.

Returns

Returns a float representing the volume level of the sound element, false if invalid arguments were passed.

Example

This example creates a sound then outputs the volume for it.

function wasted (killer, weapon, bodypart) 
	local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
	outputChatBox("Wasted Sound volume: "..getSoundVolume(sound)) --outputs to the client the volume of the sound
end
addEventHandler("onClientPlayerWasted", localPlayer, wasted) --add the event handler

Changelog

Version	Description

1.3.2

Added player element to use a players voice

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-Gets a custom sound volume.
+This function is used to return the volume level of the specified [[sound]] [[element]].
+{{New feature/item|3.0132|1.3.2||
+If the element is a [[player]], this function will use the players voice.
+}}
 ==Syntax==
-<syntaxhighlight lang="lua">float getSoundVolume ( element sound )</syntaxhighlight>
+<syntaxhighlight lang="lua">float getSoundVolume ( element theSound )</syntaxhighlight>
+{{OOP||[[sound]]:getVolume|volume|setSoundVolume}}
 ===Required Arguments===
-*'''sound:''' a sound element.
+*'''theSound:''' the [[sound]] [[element]] which volume you want to return.
 ===Returns===
-Returns a ''float'' of the sound volume, ''false'' if invalid arguements where passed.
+Returns a [[float]] representing the volume level of the [[sound]] [[element]], ''false'' if invalid arguments were passed.
 ==Example==
-TODO
+This example creates a sound then outputs the volume for it.
-<section name="Client" class="client" show="true">
 <syntaxhighlight lang="lua">
---TODO
+function wasted (killer, weapon, bodypart)
+	local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
+	outputChatBox("Wasted Sound volume: "..getSoundVolume(sound)) --outputs to the client the volume of the sound
+end
+addEventHandler("onClientPlayerWasted", localPlayer, wasted) --add the event handler
 </syntaxhighlight>
-</section>
+==Changelog==
+{{ChangelogHeader}}
+{{ChangelogItem|1.3.2|Added player element to use a players voice}}
 ==See Also==
-{{audio functions}}
+{{Client_audio_functions}}
+[[hu:getSoundVolume]]
+[[ar:getSoundVolume]]´
+[[pt-br:getSoundVolume]]