API Sound.GetVolume: Difference between revisions
XML import |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{| class="mtx-class-macrotable wikitable" | |||
Gets the volume of playbacks for this sound in the range 0 to 1 | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''GetVolume''' | |||
|- | |||
[[ | | colspan="2" | Gets the volume of playbacks for this sound in the range 0 to 1 | ||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |||
| width="90%" | Sounds | |||
= | |- | ||
| colspan="2" | The handle of the sound object to read | |||
|- | |||
| 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'' | |||
== | |} | ||
[[ | |||
==Detailed description== | ==Detailed description== | ||
The volume returned is specific to the specified handle, and affects all sounds played through this channel. | |||
| Line 27: | Line 25: | ||
* Declare a variable 'result' of type FLOAT | * Declare a variable 'result' of type FLOAT | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetVolume(sounds)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetVolume(sounds)</pre> | ||
Latest revision as of 13:17, 13 July 2026
|
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 |
Detailed description
The volume returned is specific to the specified handle, and affects all sounds played through this channel.
Examples
Calling in a calculation
- Declare a variable 'result' of type FLOAT
- Add to a calculation icon:
result = ::Sound.GetVolume(sounds)