API Sound.SetVolume: Difference between revisions
m Text replacement - "class="wikitable" style="width:60%; background-color:#FFFFFF;"" to "class="mtx-class-macrotable wikitable"" |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{| class="mtx-class-macrotable wikitable" | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetVolume''' | ||
|- | |- | ||
| colspan="2" | Sets the volume of playbacks for this sound | | colspan="2" | Sets the volume of playbacks for this sound | ||
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)