Difference between revisions of "AGIWiki/discard.view.v"

From ScummVM :: Wiki
Jump to navigation Jump to search
(fixing link)
m (Text replacement - "</source>" to "</syntaxhighlight>")
Line 41: Line 41:
 
  v100 = 203;
 
  v100 = 203;
 
  discard.view.v(v100);
 
  discard.view.v(v100);
</source>
+
</syntaxhighlight>
  
 
== Technical Information ==
 
== Technical Information ==

Revision as of 15:09, 25 October 2018

AGIWiki


Object and View Commands

The discard.view.v command removes a view resource from memory. There is an direct version of this command called discard.view.

Syntax

discard.view.v(var 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.v

  • viewNumber: a variable, v0-v255, whose value specifies which view resource to remove from memory

Possible errors

Examples

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

<source lang="cpp">

load.view(203);
v100 = 203;
discard.view.v(v100);

</syntaxhighlight>

Technical Information

Required interpreter version Available in all AGI versions
Bytecode value 153 (0x99 hex)

See also

Sources

  • Some of the text in the article is taken from the AGI Studio & WinAGI help files.