Animated Object - Revision history

Andrew Branscom: /* Blocks */

2022-02-07T00:56:19Z

Blocks

Andrew Branscom at 22:18, 14 April 2019

2019-04-14T22:18:17Z

Andrew Branscom at 16:21, 26 March 2019

2019-03-26T16:21:21Z

Andrew Branscom at 05:15, 30 December 2013

2013-12-30T05:15:47Z

Andrew Branscom: /* Initializing Objects */

2013-12-30T05:04:04Z

Initializing Objects

Andrew Branscom: /* Initializing Objects */

2013-12-30T05:03:12Z

Initializing Objects

Andrew Branscom: /* Initializing Objects */

2013-12-30T05:02:35Z

Initializing Objects

Andrew Branscom: /* Cycling Objects */

2013-12-30T04:59:35Z

Cycling Objects

Andrew Branscom: /* Positioning objects */

2013-12-30T04:58:05Z

Positioning objects

Andrew Branscom: /* Interacting with object positions */

2013-12-30T04:55:29Z

Interacting with object positions

@@ Line 185: / Line 185: @@
 === <br />Blocks ===
-You can set up an invisible rectangular block on the screen using the <code>[[block]]</code> command. The interpreter will not allow objects to cross the borders of the block, unless they have been issued the <code>[[ignore.blocks]]</code> command. Use the <code>[[observe.block]]</code> command on objects that are ignoring blocks to begin observing the block again. Use the <code>[[unblock]]</code> command to remove the block. Unlike control lines, objects cannot 'jump' over blocks, no matter how big the step size.
+You can set up an invisible rectangular block on the screen using the <code>[[block]]</code> command. The interpreter will not allow objects to cross the borders of the block, unless they have been issued the <code>[[ignore.blocks]]</code> command. Use the <code>[[observe.blocks]]</code> command on objects that are ignoring blocks to begin observing the block again. Use the <code>[[unblock]]</code> command to remove the block. Unlike control lines, objects cannot 'jump' over blocks, no matter how big the step size.
 === <br />Land and Water ===

@@ Line 1: / Line 1: @@
 ''This article refers to "screen objects" or "animated objects". For other uses of the term "object", see the [[Object]] disambiguation page.''
-'''Objects''', also known as screen objects or animated objects, provide the animation in [[AGI|AGI]] games. They can represent various things such as characters, background animations, or still props. Each object has a [[View Resource|view]] assigned to it, and objects can be placed anywhere on the screen and moved around.
+'''Objects''', also known as screen objects or animated objects, provide the animation in [[AGI|AGI]] games. They can represent various things such as characters, background animations, or still props. Each object has a [[View Resource (AGI)|view]] assigned to it, and objects can be placed anywhere on the screen and moved around.
 Object 0, commonly referred to as "[[Ego|ego]]", is special. This is the object that the player moves around using the arrow keys.

@@ Line 11: / Line 11: @@
 Before you can use a screen object, it must be initialized. Initialization involves the following steps:
-# '''Animate the object.''' This is done using the '''<code>[[animate.obj]]</code>''' command. This tells the [[Interpreter|interpreter]] that you want to use this object. There are a limited number of objects that the interpreter can use at any one time. This is set by a certain byte in the [[OBJECT File|OBJECT file]]. [[WinAGI|WinAGI]] allows you to easily edit the maximum number of screen objects. The more objects you use the slower the interpreter will run, but today's computer have less of a problem with this.
+# '''Animate the object.''' This is done using the '''<code>[[animate.obj]]</code>''' command. This tells the [[Interpreter|interpreter]] that you want to use this object. There are a limited number of objects that the interpreter can use at any one time. This is set by a certain byte in the [[OBJECT File (AGI)|AGI OBJECT file]]. [[WinAGI|WinAGI]] allows you to easily edit the maximum number of screen objects. The more objects you use the slower the interpreter will run, but today's computer have less of a problem with this.
 # '''Assign a view to the object.''' This is done using the <code>[[set.view]]</code> command. Each object must have a view assigned to it, and this is the view that is displayed on the screen wherever the object is. One view can be assigned to multiple screen objects. You must have the view loaded into memory before you assign it, using the <code><code>[[load.view]]</code> command. It is possible to assign the same view to more than one object. This can be used to create 'herds' of objects. The alligators in the King's Quest I moat are a good example.
 # '''Position the object on screen.''' The default values for the object's coordinates are (0,0). Set the initial position of the object with the <code>[[Position|position]]</code> or <code>[[Position.v|position.v]]</code> commands.

@@ Line 11: / Line 11: @@
 Before you can use a screen object, it must be initialized. Initialization involves the following steps:
-# '''Animate the object.''' This is done using the '''<code>[[animate.obj();]]</code>''' command. This tells the [[Interpreter|interpreter]] that you want to use this object. There are a limited number of objects that the interpreter can use at any one time. This is set by a certain byte in the [[OBJECT File|OBJECT file]]. [[WinAGI|WinAGI]] allows you to easily edit the maximum number of screen objects. The more objects you use the slower the interpreter will run, but today's computer have less of a problem with this.
+# '''Animate the object.''' This is done using the '''<code>[[animate.obj]]</code>''' command. This tells the [[Interpreter|interpreter]] that you want to use this object. There are a limited number of objects that the interpreter can use at any one time. This is set by a certain byte in the [[OBJECT File|OBJECT file]]. [[WinAGI|WinAGI]] allows you to easily edit the maximum number of screen objects. The more objects you use the slower the interpreter will run, but today's computer have less of a problem with this.
-# '''Assign a view to the object.''' This is done using the <code>[[set.view();]]</code> command. Each object must have a view assigned to it, and this is the view that is displayed on the screen wherever the object is. One view can be assigned to multiple screen objects. You must have the view loaded into memory before you assign it, using the <code><code>[[load.view();]]</code> command. It is possible to assign the same view to more than one object. This can be used to create 'herds' of objects. The alligators in the King's Quest I moat are a good example.
+# '''Assign a view to the object.''' This is done using the <code>[[set.view]]</code> command. Each object must have a view assigned to it, and this is the view that is displayed on the screen wherever the object is. One view can be assigned to multiple screen objects. You must have the view loaded into memory before you assign it, using the <code><code>[[load.view]]</code> command. It is possible to assign the same view to more than one object. This can be used to create 'herds' of objects. The alligators in the King's Quest I moat are a good example.
 # '''Position the object on screen.''' The default values for the object's coordinates are (0,0). Set the initial position of the object with the <code>[[Position|position]]</code> or <code>[[Position.v|position.v]]</code> commands.
 # '''Draw the object.''' This is done using the <code>[[Draw|draw]]</code> command. The object is not visible on the screen until this command is issued.If you later need to remove it from the screen, use the erase command. When drawing objects, the object's location (set by <code>[[Position|position]]</code> or <code>[[Position.v|position.v]]</code>) is validated using a method called '[[Animated Object#Shuffling|shuffling]]' to ensure the object is not drawn outside the playable area, on a control line or on another object (if the object is not ignoring other objects).
@@ Line 31: / Line 31: @@
 == <br />Cycling Objects ==
-The animation of an object is called "cycling." This is the successive display of several [[Cel|cels]] from the same [[Loop|loop]] in order. When you initialize an object, it cycles the cels in the first loop (loop 0) by default. To change the loop number, use the <code>[[Set.loop|set.loop]]</code> command. To change the speed of cycling, use the <code>[[Cycle.time|cycle.time]]</code> command. If you want to display a single cel without animation, set the loop number and cel number you want to display using the <code>[[set.loop|set.loop]]</code> and <code>[[set.cel();]]</code> commands and then use the <code>[[Stop.cycling|stop.cycling]]</code> command (you can start cycling again by using the <code>[[Start.cycling|start.cycling]]</code> command).
+The animation of an object is called "cycling." This is the successive display of several [[Cel|cels]] from the same [[Loop|loop]] in order. When you initialize an object, it cycles the cels in the first loop (loop 0) by default. To change the loop number, use the <code>[[Set.loop|set.loop]]</code> command. To change the speed of cycling, use the <code>[[Cycle.time|cycle.time]]</code> command. If you want to display a single cel without animation, set the loop number and cel number you want to display using the <code>[[set.loop|set.loop]]</code> and <code>[[set.cel]]</code> commands and then use the <code>[[Stop.cycling|stop.cycling]]</code> command (you can start cycling again by using the <code>[[Start.cycling|start.cycling]]</code> command).
 When animating, objects aren’t updated on screen until the start of the next [[Interpreter cycle|interpreter cycle]] (or until the [[Force.update|force.update]] command is issued), so whatever changes you make to an object’s position or appearance do not take affect till then.
@@ Line 233: / Line 233: @@
 When two or more objects overlap, the one with the highest priority is drawn on top. If they have the same priority, the object with the higher index number is drawn on top.
-To set an object’s priority so it will remain constant wherever the objects is on screen, use the <code>[[Set.priority|set.priority]]</code> or <code>[[Set.priority.v|set.priority.v]]</code> commands. To change it back so the priority is dependent on the object’s position, use the <code>[[release.priority();|release.priority]]</code> command.
+To set an object’s priority so it will remain constant wherever the objects is on screen, use the <code>[[Set.priority|set.priority]]</code> or <code>[[Set.priority.v|set.priority.v]]</code> commands. To change it back so the priority is dependent on the object’s position, use the <code>[[release.priority]]</code> command.
 An object’s priority can be determined using the <code>[[Get.priority|get.priority]]</code> command.

@@ Line 12: / Line 12: @@
 # '''Animate the object.''' This is done using the '''<code>[[animate.obj();]]</code>''' command. This tells the [[Interpreter|interpreter]] that you want to use this object. There are a limited number of objects that the interpreter can use at any one time. This is set by a certain byte in the [[OBJECT File|OBJECT file]]. [[WinAGI|WinAGI]] allows you to easily edit the maximum number of screen objects. The more objects you use the slower the interpreter will run, but today's computer have less of a problem with this.
-# '''Assign a view to the object.''' This is done using the <code><code>[[set.view();]]</code> command. Each object must have a view assigned to it, and this is the view that is displayed on the screen wherever the object is. One view can be assigned to multiple screen objects. You must have the view loaded into memory before you assign it, using the <code><code>[[load.view();]]</code> command. It is possible to assign the same view to more than one object. This can be used to create 'herds' of objects. The alligators in the King's Quest I moat are a good example.
+# '''Assign a view to the object.''' This is done using the <code>[[set.view();]]</code> command. Each object must have a view assigned to it, and this is the view that is displayed on the screen wherever the object is. One view can be assigned to multiple screen objects. You must have the view loaded into memory before you assign it, using the <code><code>[[load.view();]]</code> command. It is possible to assign the same view to more than one object. This can be used to create 'herds' of objects. The alligators in the King's Quest I moat are a good example.
 # '''Position the object on screen.''' The default values for the object's coordinates are (0,0). Set the initial position of the object with the <code>[[Position|position]]</code> or <code>[[Position.v|position.v]]</code> commands.
 # '''Draw the object.''' This is done using the <code>[[Draw|draw]]</code> command. The object is not visible on the screen until this command is issued.If you later need to remove it from the screen, use the erase command. When drawing objects, the object's location (set by <code>[[Position|position]]</code> or <code>[[Position.v|position.v]]</code>) is validated using a method called '[[Animated Object#Shuffling|shuffling]]' to ensure the object is not drawn outside the playable area, on a control line or on another object (if the object is not ignoring other objects).

@@ Line 12: / Line 12: @@
 # '''Animate the object.''' This is done using the '''<code>[[animate.obj();]]</code>''' command. This tells the [[Interpreter|interpreter]] that you want to use this object. There are a limited number of objects that the interpreter can use at any one time. This is set by a certain byte in the [[OBJECT File|OBJECT file]]. [[WinAGI|WinAGI]] allows you to easily edit the maximum number of screen objects. The more objects you use the slower the interpreter will run, but today's computer have less of a problem with this.
-# '''Assign a view to the object.''' This is done using the <code>'''[[set.view();]]'''</code> command. Each object must have a view assigned to it, and this is the view that is displayed on the screen wherever the object is. One view can be assigned to multiple screen objects. You must have the view loaded into memory before you assign it, using the <code>'''[[load.view();]]'''</code> command. It is possible to assign the same view to more than one object. This can be used to create 'herds' of objects. The alligators in the King's Quest I moat are a good example.
+# '''Assign a view to the object.''' This is done using the <code><code>[[set.view();]]</code> command. Each object must have a view assigned to it, and this is the view that is displayed on the screen wherever the object is. One view can be assigned to multiple screen objects. You must have the view loaded into memory before you assign it, using the <code><code>[[load.view();]]</code> command. It is possible to assign the same view to more than one object. This can be used to create 'herds' of objects. The alligators in the King's Quest I moat are a good example.
-# '''Position the object on screen.''' The default values for the object's coordinates are (0,0). Set the initial position of the object with the '''[[Position|position]]''' or '''[[Position.v|position.v]]''' commands.
+# '''Position the object on screen.''' The default values for the object's coordinates are (0,0). Set the initial position of the object with the <code>[[Position|position]]</code> or <code>[[Position.v|position.v]]</code> commands.
-# '''Draw the object.''' This is done using the '''[[Draw|draw]]''' command. The object is not visible on the screen until this command is issued.If you later need to remove it from the screen, use the erase command. When drawing objects, the object's location (set by '''[[Position|position]]''' or '''[[Position.v|position.v]]''') is validated using a method called '[[Animated Object#shuffling|shuffling]]' to ensure the object is not drawn outside the playable area, on a control line or on another object (if the object is not ignoring other objects).
+# '''Draw the object.''' This is done using the <code>[[Draw|draw]]</code> command. The object is not visible on the screen until this command is issued.If you later need to remove it from the screen, use the erase command. When drawing objects, the object's location (set by <code>[[Position|position]]</code> or <code>[[Position.v|position.v]]</code>) is validated using a method called '[[Animated Object#shuffling|shuffling]]' to ensure the object is not drawn outside the playable area, on a control line or on another object (if the object is not ignoring other objects).
 === <br />Example ===

@@ Line 31: / Line 31: @@
 == <br />Cycling Objects ==
-The animation of an object is called "cycling." This is the successive display of several [[Cel|cels]] from the same [[Loop|loop]] in order. When you initialize an object, it cycles the cels in the first loop (loop 0) by default. To change the loop number, use the '''[[Set.loop|set.loop]]''' command. To change the speed of cycling, use the '''[[Cycle.time|cycle.time]]''' command. If you want to display a single cel without animation, set the loop number and cel number you want to display using the '''[[set.loop|set.loop]]''' and '''[[set.cel();]]''' commands and then use the '''[[Stop.cycling|stop.cycling]]''' command (you can start cycling again by using the '''[[Start.cycling|start.cycling]]''' command).
+The animation of an object is called "cycling." This is the successive display of several [[Cel|cels]] from the same [[Loop|loop]] in order. When you initialize an object, it cycles the cels in the first loop (loop 0) by default. To change the loop number, use the <code>[[Set.loop|set.loop]]</code> command. To change the speed of cycling, use the <code>[[Cycle.time|cycle.time]]</code> command. If you want to display a single cel without animation, set the loop number and cel number you want to display using the <code>[[set.loop|set.loop]]</code> and <code>[[set.cel();]]</code> commands and then use the <code>[[Stop.cycling|stop.cycling]]</code> command (you can start cycling again by using the <code>[[Start.cycling|start.cycling]]</code> command).
 When animating, objects aren’t updated on screen until the start of the next [[Interpreter cycle|interpreter cycle]] (or until the [[Force.update|force.update]] command is issued), so whatever changes you make to an object’s position or appearance do not take affect till then.
@@ Line 79: / Line 79: @@
 : ''Forward Cycle''
-:: In the forward cycle mode, the cels are displayed in increasing numerical order, i.e., cel 0, then cel 1, etc. After the last cel is reached, the interpreter goes back to cel 0 and starts over. The view will continue to cycle indefinitely. This is the default mode. Use the '''[[Normal.cycle|normal.cycle]]''' command to switch to this mode.
+:: In the forward cycle mode, the cels are displayed in increasing numerical order, i.e., cel 0, then cel 1, etc. After the last cel is reached, the interpreter goes back to cel 0 and starts over. The view will continue to cycle indefinitely. This is the default mode. Use the <code>[[Normal.cycle|normal.cycle]]</code> command to switch to this mode.
 : ''Reverse Cycle''
-:: In the reverse cycle mode, the cels are displayed in decreasing numerical order, i.e., cel ''X'', cel ''X-1'', etc. (where ''X'' is last cel). After the first cel is reached, the interpreter goes back to cel ''X'' and starts over. The view will continue to cycle indefinitely. Use the '''[[Reverse.cycle|reverse.cycle]]''' command to switch to this mode.
+:: In the reverse cycle mode, the cels are displayed in decreasing numerical order, i.e., cel ''X'', cel ''X-1'', etc. (where ''X'' is last cel). After the first cel is reached, the interpreter goes back to cel ''X'' and starts over. The view will continue to cycle indefinitely. Use the <code>[[Reverse.cycle|reverse.cycle]]</code> command to switch to this mode.
 : ''Forward to End''
-:: In this mode, the cels cycle in the forward direction, but once the last cel is shown, cycling stops. Use the '''[[End.of.loop|end.of.loop]]''' command to switch to this mode.
+:: In this mode, the cels cycle in the forward direction, but once the last cel is shown, cycling stops. Use the <code>[[End.of.loop|end.of.loop]]</code> command to switch to this mode.
 : ''Reverse to Beginning''
-:: In this mode, the cels cycle in the reverse direction, but once the first cel is shown, cycling stops. Use the '''[[Reverse.loop|reverse.loop]]''' command to switch to this mode.
+:: In this mode, the cels cycle in the reverse direction, but once the first cel is shown, cycling stops. Use the <code>[[Reverse.loop|reverse.loop]]</code> command to switch to this mode.
 == Positioning objects ==

@@ Line 92: / Line 92: @@
 == Positioning objects ==
-As discussed above in the [[Animated Object#Initializing objects|initialization]] section, the '''[[Position|position]]''' and '''[[Position.v|position.v]]''' commands set the initial position for an object before it is drawn on the screen.
+As discussed above in the [[Animated Object#Initializing objects|initialization]] section, the <code>[[Position|position]]</code> and <code>[[Position.v|position.v]]</code> commands set the initial position for an object before it is drawn on the screen.
 When positioning objects, you need to remember that the 'anchor point' for objects is the lower left corner of the current cel. Be sure to adjust the coordinates passed to positioning commands to allow for the height and width of your object.
-After the object has been animated, it is possible to reposition the object. However, do NOT use the '''[[Position|position]]''' and '''[[Position.v|position.v]]''' commands. For objects that are already visible on the screen, use the '''[[Reposition|reposition]]''', '''[[Reposition.to|reposition.to]]''' and '''[[Reposition.to.v|reposition.to.v]]''' commands instead.
+After the object has been animated, it is possible to reposition the object. However, do NOT use the <code>[[Position|position]]</code> and <code>[[Position.v|position.v]]</code> commands. For objects that are already visible on the screen, use the <code>[[Reposition|reposition]]</code>, <code>[[Reposition.to|reposition.to]]</code> and <code>[[Reposition.to.v|reposition.to.v]]</code> commands instead.
 The '''re'''positioning commands will erase the object from its current location before redrawing it in its new location; the position commands do not.
-The '''[[Reposition.to|reposition.to]]''' and '''[[Reposition.to.v|reposition.to.v]]''' commands are similar to the '''[[Position|position]]''' and '''[[Position.v|position.v]]''' commands. You can pass a set of new coordinates for the object and it repositions itself during the next interpreter cycle update.
+The <code>[[Reposition.to|reposition.to]]</code> and <code>[[Reposition.to.v|reposition.to.v]]</code> commands are similar to the <code>[[Position|position]]</code> and <code>[[Position.v|position.v]]</code> commands. You can pass a set of new coordinates for the object and it repositions itself during the next interpreter cycle update.
-The '''[[Reposition|reposition]]''' command is slightly different; it takes as arguments horizontal and vertical offsets from the object's current position, instead of absolute values. The argument values are treated as signed 8 bit numbers, so negative offsets can be achieved. More details are available in the remarks section of the '''[[Reposition|reposition]]''' command topic.
+The <code>[[Reposition|reposition]]</code> command is slightly different; it takes as arguments horizontal and vertical offsets from the object's current position, instead of absolute values. The argument values are treated as signed 8 bit numbers, so negative offsets can be achieved. More details are available in the remarks section of the <code>[[Reposition|reposition]]</code> command topic.
 === <br />Shuffling ===

@@ Line 114: / Line 114: @@
 === <br />Interacting with object positions ===
-During game play, it may be important to be aware of objects' positions. The '''[[Get.posn|get.posn]]''' command is used to determine the current coordinates of an object. These values can then be used to take actions based on the object's position.
+During game play, it may be important to be aware of objects' positions. The <code>[[get.posn]]</code> command is used to determine the current coordinates of an object. These values can then be used to take actions based on the object's position.
-There are also four test commands that can be used to analyze an object's position. The '''[[Posn|posn]]''', '''[[Right.posn|right.posn]]''', '''[[Center.posn|center.posn]]''' and '''[[Obj.in.box|obj.in.box]]''' commands all compare an object's position to a specified rectangular area, and return TRUE if the object is inside the box.
+There are also four test commands that can be used to analyze an object's position. The <code>[[posn]]</code>, <code>[[right.posn]]</code>, <code>[[center.posn]]</code> and <code>[[obj.in.box]]</code> commands all compare an object's position to a specified rectangular area, and return TRUE if the object is inside the box.
-The difference between the commands is how they determine what 'in the box' means. The '''[[Posn|posn]]''' command uses the anchor (bottom-left) point in the test; the '''[[Center.posn|center.posn]]''' and '''[[Right.posn|right.posn]]''' use the bottom-center point, and bottom-right point, respectively. The '''[[Obj.in.box|obj.in.box]]''' command checks that the entire bottom line is within the area.
+The difference between the commands is how they determine what 'in the box' means. The <code>[[posn]]</code> command uses the anchor (bottom-left) point in the test; the <code>[[center.posn]]</code> and <code>[[right.posn]]</code> use the bottom-center point, and bottom-right point, respectively. The <code>[[obj.in.box]]</code> command checks that the entire bottom line is within the area.
 These commands are very useful to be able to trigger certain events if an object approaches a given area of the screen. For example, if ego gets close enough to a door, you might want to make the door automatically open.