API Sound.SetVolume: Difference between revisions

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)
```

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API Contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Sets the volume of playbacks for this sound
+| width="90%" class="mtx-class-macrohead" | '''SetVolume'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Sets the volume of playbacks for this sound&nbsp;
-====Class hierarchy====
+|-
-[[API Sound|Sound]]
+|-
-:[[API Sound|SetVolume]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-</div>
+| width="90%" | Sounds
-__TOC__
+|-
+| colspan="2" | The handle of the sound object to set the volume for&nbsp;
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Sounds''
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-:The handle of the sound object to set the volume for
+| width="90%" | Volume
+|-
-[[Variable Types|FLOAT]] ''Volume''
+| colspan="2" | A value from 0=off to 1=full&nbsp;
-: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''
-==Return value==
+|}
-''This call does not return a value''
@@ Line 30: / Line 29: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetVolume(sounds, volume)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 13:17, 13 July 2026

Detailed description

Examples

Calling in a calculation