Difference between revisions of "AGIWiki/discard.view"

From ScummVM :: Wiki
Jump to navigation Jump to search
m (Created page with "{{AGIWiki}} The '''discard.view''' command removes a view resource from memory. There is an indirect version of this command called...")
 
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__
{{AGIWiki}}
{{AGIWiki}}
 
{{AGIWiki/Object and View commands}}
The '''discard.view''' command removes a [[AGIWiki/View|view resource]] from memory. There is an [[AGIWiki/Indirect command|indirect]] version of this command called '''[[AGIWiki/discard.view.v|discard.view.v]]'''.
The '''discard.view''' command removes a [[AGIWiki/View|view resource]] from memory. There is an [[AGIWiki/Indirect command|indirect]] version of this command called '''[[AGIWiki/discard.view.v|discard.view.v]]'''.


== Syntax ==
== Syntax ==


: discard.view([[AGIWiki/Number|Byt]] viewNumber);
: discard.view([[AGIWiki/Number|byt]] viewNumber);


View <code>viewNumber</code> is discarded from memory.
View <code>viewNumber</code> is discarded from memory.
Line 36: Line 37:
The following example uses <code>discard.view</code> to remove view 203 from memory:
The following example uses <code>discard.view</code> to remove view 203 from memory:


<syntax type = "C++">
<syntaxhighlight lang="cpp">
  load.view(203);
  load.view(203);
  discard.view(203);
  discard.view(203);
</syntax>
</syntaxhighlight>


== Technical Information ==
== Technical Information ==
Line 55: Line 56:
* [[AGIWiki/discard.view.v|discard.view.v]]
* [[AGIWiki/discard.view.v|discard.view.v]]
* [[AGIWiki/load.view|load.view]]
* [[AGIWiki/load.view|load.view]]
* [[AGIWiki/load.view.v|load.view.v]]
* [[AGIWiki/load.view|load.view.v]]


== Sources ==
== Sources ==

Latest revision as of 15:17, 25 October 2018

AGIWiki


Object and View Commands

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

Examples

The following example uses discard.view to remove view 203 from memory:

 load.view(203);
 discard.view(203);

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.