Difference between revisions of "API Sound.Flush"

Latest revision as of 11:55, 16 January 2023

	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="wikitable" style="width:60%; background-color:#FFFFFF;"
-Stops all playing and queued sounds
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
+|}
-===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===
+==Examples==
-''No additional information''
+===Calling in a calculation===
+* Add to a calculation icon: <pre class="brush:[cpp]">::Sound.Flush(sounds)</pre>
-===Examples===
-====Calling in a calculation====
-* Add to a calculation icon: ::Sound.Flush(sounds)