API Sound.SetVolume: Difference between revisions
No edit summary |
No edit summary |
||
| Line 29: | 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> | ||
Revision as of 11:55, 16 January 2023
|
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)