Difference between revisions of "Animate.obj"

From AGI Wiki
Jump to navigationJump to search
m (Collector moved page Animate.obj to Animate.obj();)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The '''animate.obj''' command tells the interpreter to activate the specified object. An object must be activated in the current room before it can be used.
+
The '''animate.obj''' command initializes a [[screen object]] so it can be used on screen.
  
<code>animate.obj(object);</code>
+
== Syntax ==
  
== Parameters ==
+
animate.obj([[screen object|obj]] oA);
  
* <code>object</code>: an object, <code>o0-o255;</code> this object will be activated for use ('''note:''' the [[AGI Studio Template Game]] supports only <code>o0-o15</code>)
+
== Remarks ==
  
== Possible errors ==
+
[[Screen object|Screen objects]] must be initialized with the '''animate.obj''' command before they can be used in any other commands. When a [[screen object]] is initialized it is enabled for [[updating]] and [[cycling]] by default. If you call the '''animate.obj''' command on an object that is already initialized, the command is ignored.
  
* if you specify an [[Animated Object|object]] that is outside the range specified in the [[OBJECT file]], the game will crash with a [[bad object number error]] (note: in the AGI Studio Template Game, the maximum number of objects is 16, meaning that <code>o0</code> through <code>o15</code> are valid; if you specify <code>o16</code>, then this error will occur)
+
== Possible Errors ==
  
== Examples ==
+
If the object number exceeds the [[max screen object]] count, AGI will raise [[trappable error #13]].
  
The following example activates object 3 and assigned VIEW.035 to it:
+
Most commands that are run on an uninitialized screen objects are just ignored by AGI, but some of them can result in interactions with invalid data.
  
<div class="CodeBlockHeader">Code:</div>
+
== Example ==
<syntaxhighlight lang="agi">
 
animate.obj(o3);
 
load.view(35);
 
set.view(o3, 35);
 
</syntaxhighlight>
 
  
&nbsp;
 
 
<div class="CodeBlockHeader">Code:</div>
 
<div class="CodeBlockHeader">Code:</div>
 
<syntaxhighlight lang="agi">
 
<syntaxhighlight lang="agi">
//basic steps needed to create
+
[ basic steps needed to create
//and display a screen object
+
[ and display a screen object
 
animate.obj(o2);
 
animate.obj(o2);
 
load.view(4);
 
load.view(4);
Line 34: Line 28:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
&nbsp;
 
 
== Syntax ==
 
 
: animate.obj([[Screen objects|obj]] oA);
 
 
== Remarks ==
 
 
If the object number exceeds the [[Screen objects#Maximum screen objects|max screen object]] count, AGI will generate an error.
 
 
Screen objects must be activated with the '''animate.obj''' command before it can be used in any other commands. Attempting to run commands on an uninitialized screen object will generate a runtime error.
 
 
If you call the '''animate.obj''' command on an object that is already activated, the command is ignored.
 
 
&nbsp;
 
 
== Technical Information ==
 
== Technical Information ==
  
 
{| border="1" cellpadding="2"
 
{| border="1" cellpadding="2"
| style="background-color: #efefef" | '''Required interpreter version'''
+
| style="background-color: #efefef" width="200" | '''Required Interpreter Version:'''
| Available in all AGI versions
+
| width="175" | Available in all AGI versions.
 
|-
 
|-
| style="background-color: #efefef" | '''Bytecode value'''
+
| style="background-color: #efefef" | '''Byte-Code Value:'''
 
| 33 (0x21 hex)
 
| 33 (0x21 hex)
 
|}
 
|}
  
== See also ==
+
== See Also ==
 
 
* [[unanimate.all]]
 
* [[Object|Objects]]
 
 
 
== Sources ==
 
 
 
Some of the text in this article comes from the [[AGI Studio]] help file.
 
  
&nbsp;
+
[[Screen Object/View Commands]]<br />
 +
[[Working with Screen Objects]]<br />
  
[[Category:Logic Commands]]
+
[[Category:Commands]]
[[Category:Object and View Commands]]
 

Latest revision as of 17:05, 23 March 2019

The animate.obj command initializes a screen object so it can be used on screen.

Syntax

animate.obj(obj oA);

Remarks

Screen objects must be initialized with the animate.obj command before they can be used in any other commands. When a screen object is initialized it is enabled for updating and cycling by default. If you call the animate.obj command on an object that is already initialized, the command is ignored.

Possible Errors

If the object number exceeds the max screen object count, AGI will raise trappable error #13.

Most commands that are run on an uninitialized screen objects are just ignored by AGI, but some of them can result in interactions with invalid data.

Example

Code:
[ basic steps needed to create
[ and display a screen object
animate.obj(o2);
load.view(4);
set.view(o2,4);
position(o2,80,120);
draw(o2);

Technical Information

Required Interpreter Version: Available in all AGI versions.
Byte-Code Value: 33 (0x21 hex)

See Also

Screen Object/View Commands
Working with Screen Objects