API Sound.GetVolume: Difference between revisions

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: @@
-<sidebar>API contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Gets the volume of playbacks for this sound in the range 0 to 1
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetVolume'''
+|-
+| colspan="2" | Gets the volume of playbacks for this sound in the range 0 to 1&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Sounds
+|-
+| colspan="2" | The handle of the sound object to read&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===[[API Sound|Sound]]
-:[[API Sound|GetVolume]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''[[Variable types|HANDLE]] Sounds''
+The volume returned is specific to the specified handle, and affects all sounds played through this channel.
-:The handle of the sound object to read
-==Return value==
-[[Variable types|FLOAT]]
-Returns the volume of playbacks for this sound in the range 0 to 1
-==Detailed description==
-''No additional information''
 ==Examples==