API Sound.Flush: Difference between revisions

Latest revision as of 13:17, 13 July 2026

	Flush
Stops all playing and queued sounds
- HANDLE	Sounds
The handle of the sound object to flush
- NONE	Return

This will cause all sound waves currently playing or queued in the handle to be discarded.

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Stops all playing and queued sounds
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''Flush'''
+|-
+| colspan="2" | Stops all playing and queued sounds&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Sounds
+|-
+| colspan="2" | The handle of the sound object to flush&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''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===[[API |API ]]
-:[[API Sound|Sound]]
-::Flush
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''[[Variable types|HANDLE]] Sounds''
+This will cause all sound waves currently playing or queued in the handle to be discarded.
-:The handle of the sound object to flush
-==Return value==
-''This call does not return a value''
-==Detailed description==
-''No additional information''
 ==Examples==
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Sound.Flush(sounds)</pre>