API Sound.SetVolume: Difference between revisions
XML import |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''SetVolume''' | |||
|- | |||
[[ | | colspan="2" | Sets the volume of playbacks for this sound | ||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |||
| width="90%" | Sounds | |||
== | |- | ||
[[ | | colspan="2" | The handle of the sound object to set the volume for | ||
|- | |||
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | |||
[[ | | width="90%" | Volume | ||
|- | |||
| colspan="2" | A value from 0=off to 1=full | |||
|- | |||
== | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE | ||
'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |||
| Line 28: | Line 29: | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetVolume(sounds, volume)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetVolume(sounds, volume)</pre> | ||
Latest revision as of 13:17, 13 July 2026
|
SetVolume |
| Sets the volume of playbacks for this sound | |
 - HANDLE
|
Sounds |
| The handle of the sound object to set the volume for | |
 - FLOAT
|
Volume |
| A value from 0=off to 1=full | |
 - NONE
|
Return |
Detailed description
This sets the volume for all sounds played through the given channel. The effects are instant - a sound part way through being played will have its volume affected, as will any sounds being queued.
Examples
Calling in a calculation
- Add to a calculation icon:
::Sound.SetVolume(sounds, volume)