AGIWiki/discard.view
< AGIWiki
Jump to navigation
Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
The discard.view command removes a view resource from memory. There is an indirect version of this command called discard.view.v.
Syntax
- discard.view(byt viewNumber);
View viewNumber
is discarded from memory.
Remarks
Resources must be unloaded in reverse order of the way they were originally loaded, or unexpected results may occur.
Attempting to discard a resource that has not been loaded will generate an error.
Before unloading a view, make certain it is not in use by any active screen objects. If a view is unloaded while still assigned to an object, the interpreter will most likely crash.
AGI adds a script entry to the script stack each time a view resource is unloaded.
Parameters
For discard.view
viewNumber
: a number, 0-255, specifying which view resource to remove from memory
Possible errors
- if the view is not already loaded, the game will crash with a view not loaded error
- if the view is assigned to an object when it is discarded, the game may crash or exhibit other odd behavior; it may not even generate an error message
- resources must be discarded in exactly the reverse order that they were loaded, or subsequent
discard.view
commands may generate a view not loaded error, even if the view has actually been loaded; see Memory and Script for more details on this issue - the
discard.view
anddiscard.view.v
commands add to the script buffer; this can cause a script buffer overflow error
Examples
The following example uses discard.view
to remove view 203 from memory:
<syntaxhighlight lang="cpp">
load.view(203); discard.view(203);
</source>
Technical Information
Required interpreter version | Available in all AGI versions |
Bytecode value | 32 (0x20 hex) |
See also
Sources
- Some of the text in the article is taken from the AGI Studio & WinAGI help files.