AGIWiki/discard.view

Object and View Commands add.to.pic add.to.pic.v animate.obj block cel current.loop current.view cycle.time discard.view discard.view.v distance draw end.of.loop erase fix.loop follow.ego force.update get.dir get.posn get.priority ignore.blocks ignore.horizon ignore.objs last.cel load.view load.view.v move.obj move.obj.v normal.cycle normal.motion number.of.loops object.on.anything object.on.land object.on.water observe.blocks observe.horizon observe.objs position position.v release.loop release.priority reposition.to reposition.to.v reposition reserve.cycle reserve.loop set.cel set.cel.v set.dir set.horizon set.loop set.loop.v set.priority set.priority.v set.upper.left set.view set.view.v start.cycling start.motion start.update step.size step.time stop.cycling stop.motion stop.update unanimate.all unblock wander

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 and discard.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

• discard.view.v
• load.view
• load.view.v

Sources

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