Difference between revisions of "AGIWiki/Sound command"

From ScummVM :: Wiki
Jump to navigation Jump to search
(→‎Example: Fix syntax highlighting)
m (Text replacement - "<source lang=" to "<syntaxhighlight lang=")
Line 19: Line 19:
  
 
== Example ==
 
== Example ==
<source lang="cpp">
+
<syntaxhighlight lang="cpp">
 
load.sound(22);
 
load.sound(22);
 
sound(22, f99);
 
sound(22, f99);

Revision as of 15:04, 25 October 2018

AGIWiki


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

<syntaxhighlight lang="cpp"> load.sound(22); sound(22, f99); </source>

Technical Information

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

See Also

Sources