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: @@
-wiki page name
+{| class="mtx-class-macrotable wikitable"
-==SoundSetVolume==
+|-
+| 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&nbsp;
+|-
+|-
+| 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&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Volume
+|-
+| colspan="2" | A value from 0=off to 1=full&nbsp;
+|-
+| 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''
+|}
-Sets the volume of playbacks for this sound
-----
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Sounds''
+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.
-:The handle of the sound object to set the volume for
-''[[Variable types|FLOAT]] Volume''
-:A value from 0=off to 1=full
-===Return value===
+==Examples==
-''This call does not return a value''
+===Calling in a calculation===
+* Add to a calculation icon: <pre class="brush:[cpp]">::Sound.SetVolume(sounds, volume)</pre>
-===Detailed description===
-''No additional information''
-===Examples===
-====Calling in a calculation:====
-* Add to a calculation icon: ::Sound.SetVolume(sounds, volume)

SteveT (talk | contribs)

Latest revision as of 13:17, 13 July 2026

Detailed description

Examples

Calling in a calculation