Difference between revisions of "AGIWiki/Sound command"

Latest revision as of 15:07, 25 October 2018

sound

The sound command plays a loaded sound resource.

Syntax

sound(byt SOUNDNUM, flg fDONE);

Remarks

The sound must be loaded with the load.sound command before it can be played.

The flag fDONE is cleared before the sound starts. When the sound stops playing (by reaching the end of the resource, or by issuing the stop.sound command) fDONE is set to TRUE.

If a sound is currently being played, it will stop, and its done flag will be set before this sound is played.

Example

load.sound(22);
sound(22, f99);

Technical Information

Required interpreter version	Available in all AGI versions
Bytecode value	0x63

Sources

WinAGI help file

@@ Line 10: / Line 10: @@
 sound([[AGIWiki/Argument types|byt]] SOUNDNUM, [[AGIWiki/Flag|flg]] fDONE);
-== Remarks ===
+== Remarks ==
 The sound must be loaded with the [[AGIWiki/load.sound|<code>load.sound</code>]] command before it can be played.
@@ Line 19: / Line 19: @@
 == Example ==
-<syntax type="C++">
+<syntaxhighlight lang="cpp">
 load.sound(22);
 sound(22, f99);
-</syntax>
+</syntaxhighlight>
-== Required Interpreter Version ==
+== Technical Information ==
-Available in all AGI versions.
+{| border="1" cellpadding="2"
+| style="background-color: #efefef" | '''Required interpreter version'''
-== Bytecode Value ==
+| Available in all AGI versions
+|-
-x63
+| style="background-color: #efefef" | '''Bytecode value'''
+| 0x63
+|}
 == See Also ==
@@ Line 39: / Line 41: @@
 * [[AGIWiki/WinAGI|WinAGI]] help file
+[[Category:AGIWiki/Sounds Commands]]