Difference between revisions of "API Sound.GetVolume"

Latest revision as of 11:55, 16 January 2023

	GetVolume
Gets the volume of playbacks for this sound in the range 0 to 1
- HANDLE	Sounds
The handle of the sound object to read
- FLOAT	Return

The volume returned is specific to the specified handle, and affects all sounds played through this channel.

@@ Line 1: / Line 1: @@
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
-<sidebar>API Contents</sidebar>
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-Gets the volume of playbacks for this sound in the range 0 to 1
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetVolume'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Gets the volume of playbacks for this sound in the range 0 to 1&nbsp;
-====Class hierarchy====
+|-
-[[API Sound|Sound]]
+|-
-:[[API Sound|GetVolume]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-</div>
+| width="90%" | Sounds
-__TOC__
+|-
+| colspan="2" | The handle of the sound object to read&nbsp;
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Sounds''
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
-:The handle of the sound object to read
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-==Return value==
-[[Variable Types|FLOAT]]
-Returns the volume of playbacks for this sound in the range 0 to 1
@@ Line 30: / Line 25: @@
 * Declare a variable 'result' of type FLOAT
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetVolume(sounds)</pre>
-''<span style="color:red;">No additional examples</span>''