Stop.sound

From AGI Wiki
Revision as of 20:18, 23 April 2019 by Andrew Korson (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

The stop.sound command stops a sound resource that is playing.

Syntax

stop.sound();

Remarks

If a sound is currently playing, this command will stop it, and set the done flag associated with the sound to TRUE. If no sound is currently playing, this command does nothing.

Possible Errors

None.

Example

Code:

<syntaxhighlight lang="agi"> load.sound(20); sound(20, f199); ... stop.sound(); [ f199 is now set to TRUE </syntaxhighlight>

Technical Information

Required Interpreter Version: Available in all AGI versions.
Byte-Code Value: 100 (0x64 hex)

See Also

Sound Commands