Andrew Korson: /* Possible Errors */

2019-04-12T23:33:06Z

Possible Errors

Andrew Korson: Created page with "The '''normal.cycle''' command switches an object's cycle mode to 'normal'. == Syntax == normal.cycle(obj oA); == Remarks == In 'normal' cycle mode..."

2019-04-12T23:08:46Z

Created page with "The '''normal.cycle''' command switches an object's cycle mode to 'normal'. == Syntax == normal.cycle(obj oA); == Remarks == In 'normal' cycle mode..."

New page

The '''normal.cycle''' command switches an object's [[cycle mode]] to 'normal'.

== Syntax ==

normal.cycle([[screen object|obj]] oA);

== Remarks ==

In 'normal' [[cycle mode]], [[screen object]] '''oA''' will cycle through the [[cels]] in the current [[loop]] from first to last. The cycle repeats indefinitely.

Setting the cycle mode to 'normal' will '''NOT''' automatically enable the object for [[updating]] if it is not currently enabled. You must use the '''[[start.update]]''' command to enable updating. The [[cycling property]] is enabled.

Changing cycle mode does not change the current [[cel]]. The new cycle mode begins with whatever cel is currently assigned to the object.

Use the '''[[stop.cycling]]''' command to turn cycling off. The '''[[end.of.loop]]''', '''[[reverse.cycle]]''' and '''[[reverse.loop]]''' commands can be used to switch to other cycle modes.

== Possible Errors ==

AGI does not check that the [[screen object]] number '''oA''' is valid. If the object has not been [[initialized]], the '''normal.cycle''' command still sets the cycle mode to normal; nothing will happen though. If the object number exceeds the [[max screen object]] number, data used for other purposes will be overwritten, which may result in unexpected results, including possibly [[ crashing AGI]].

== Example ==

<div class="CodeBlockHeader">Code:</div>
<syntaxhighlight lang="agi">
#define elevator o5
[ initialize the object, and draw it on screen
...
normal.cycle(elevator); [ going up...
...
reverse.cycle(elevator); [ going down...
</syntaxhighlight>

== Technical Information ==

{| border="1" cellpadding="2"
| style="background-color: #efefef" width="200" | '''Required Interpreter Version:'''
| width="175" | Available in all AGI versions.
|-
| style="background-color: #efefef" | '''Byte-Code Value:'''
| 72 (0x48 hex)
|}

== See Also ==

'''[[end.of.loop]]'''<br />
'''[[reverse.cycle]]'''<br />
'''[[reverse.loop]]'''<br />
'''[[stop.cycling]]'''<br />
[[Cycling Objects]]<br />
[[Category:Commands]]<br />

@@ Line 17: / Line 17: @@
 == Possible Errors ==
-AGI does not check that the [[screen object]] number '''oA''' is valid. If the object has not been [[initialized]], the '''normal.cycle''' command still sets the cycle mode to normal; nothing will happen though. If the object number exceeds the [[max screen object]] number, data used for other purposes will be overwritten, which may result in unexpected results, including possibly [[ crashing AGI]].
+AGI does not check that '''oA''' is a valid [[screen object]]. If the screen object has not been [[initialized]], the '''normal.cycle''' command still sets the cycle mode to normal; nothing will happen though. If the object number exceeds the [[max screen object]] number, data used for other purposes will be overwritten, which may result in unexpected results, including possibly [[crashing AGI]].
 == Example ==

Normal.cycle - Revision history

Andrew Korson: /* Possible Errors */

Andrew Korson: Created page with "The '''normal.cycle''' command switches an object's cycle mode to 'normal'. == Syntax == normal.cycle(obj oA); == Remarks == In 'normal' cycle mode..."