Difference between revisions of "Discard.sound"
| Line 1: | Line 1: | ||
| − | + | The '''discard.sound''' command unloads a [[Sound Resource (AGI)|sound]] resource from the [[memory heap]]. | |
| − | + | == Syntax == | |
| − | |||
| − | + | discard.sound([[number|byt]] A); | |
| − | + | == Remarks == | |
| − | |||
| − | |||
| − | + | In the PC version of AGI, this command points to a null function, and does nothing. | |
| − | + | Early versions of AGI did not include a command to unload [[Sound Resource (AGI)|sound]] resources. Since sounds were usually small and only used in limited circumstances, this was not usually a problem. Beginning with [[version]] 2.938, Sierra added this command to allow sounds to be unloaded once they were no longer needed. However, they did not make the command functional in the PC version; it only unloads sounds in non-PC interpreters. | |
| − | |||
| − | |||
| − | == | + | == Possible Errors == |
| − | + | Presumably, attempting to discard a [[Sound Resource (AGI)|sound]] that hasn't been loaded will cause errors and crash AGI. | |
| − | |||
| − | |||
| − | == | + | == Example == |
| − | |||
<div class="CodeBlockHeader">Code:</div> | <div class="CodeBlockHeader">Code:</div> | ||
<syntaxhighlight lang="agi"> | <syntaxhighlight lang="agi"> | ||
| − | discard.sound( | + | discard.sound(12); [ does nothing on PC based system |
| + | [ on non-PC system, sound #12 is unloaded | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | == | + | == Technical Information == |
| − | {| | + | {| border="1" cellpadding="2" |
| − | + | | style="background-color: #efefef" width="200" | '''Required Interpreter Version:''' | |
| + | | width="175" | Available in version 2.936 and above, on non-PC interpreters. | ||
|- | |- | ||
| − | | | + | | style="background-color: #efefef" | '''Byte-Code Value:''' |
| + | | 175 (0xAF hex) | ||
|} | |} | ||
| − | == | + | == See Also == |
| − | + | [[Sound Commands]]<br /> | |
| − | + | [[Category:Commands]]<br /> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 22:22, 29 March 2019
The discard.sound command unloads a sound resource from the memory heap.
Syntax
discard.sound(byt A);
Remarks
In the PC version of AGI, this command points to a null function, and does nothing.
Early versions of AGI did not include a command to unload sound resources. Since sounds were usually small and only used in limited circumstances, this was not usually a problem. Beginning with version 2.938, Sierra added this command to allow sounds to be unloaded once they were no longer needed. However, they did not make the command functional in the PC version; it only unloads sounds in non-PC interpreters.
Possible Errors
Presumably, attempting to discard a sound that hasn't been loaded will cause errors and crash AGI.
Example
<syntaxhighlight lang="agi"> discard.sound(12); [ does nothing on PC based system
[ on non-PC system, sound #12 is unloaded
</syntaxhighlight>
Technical Information
| Required Interpreter Version: | Available in version 2.936 and above, on non-PC interpreters. |
| Byte-Code Value: | 175 (0xAF hex) |
