Andrew Korson at 18:29, 21 April 2019

2019-04-21T18:29:50Z

Andrew Branscom: Created page with "set.loop.v ==
Syntax ==
`set.loop.v(oA,vB);`
== Description == The current loop of object oA is set to vB. If an i..."

2013-12-30T03:44:15Z

Created page with "set.loop.v == <br />Syntax == <blockquote><code>set.loop.v(oA,vB);</code></blockquote> == Description == The current loop of object oA is set to vB. If an i..."

New page

set.loop.v

 

== <br />Syntax ==

<blockquote><code>set.loop.v(oA,vB);</code></blockquote>

 
== Description ==

The current loop of object oA is set to vB. If an invalid loop number is given, the interpreter generates an error. If the current cel of the object is greater than the last cel in loop vB, then the current cel is set to 0.

 
== Sources ==

[[AGI Studio Help File]]

 

== See also ==

* <code>[[set.loop]]</code>
* <code>[[current.loop]]</code>
* <code>[[number.of.loops]]</code>
* <code>[[set.cel]]</code>
* <code>[[set.cel.v]]</code>
* <code>[[Cycling objects]]</code>

 

[[Category:Object Commands]]
[[Category:View Commands]]

@@ Line 1: / Line 1: @@
-set.loop.v
+The '''set.loop.v''' command assigns a loop to a screen object indirectly.
-&nbsp;
+== Syntax ==
-== <br />Syntax ==
+set.loop.v([[screen object|obj]] oA, [[variable|var]] vLOOP);
-<blockquote><code>set.loop.v(oA,vB);</code></blockquote>
+== Remarks ==
-&nbsp;
+The current [[loop]] of [[screen object]] oA is set to the value of [[variable]] '''vLOOP'''.
-The current loop of object oA is set to vB. If an invalid loop number is given, the interpreter generates an error. If the current cel of the object is greater than the last cel in loop vB, then the current cel is set to 0.
+A [[View Resource (AGI)|view]] must be be assigned to the object first. If a view is not assigned, AGI raises [[trappable error #6]]. If '''vLOOP''' is not a valid loop number, i.e. it exceeds the maximum number of available loops in the view, AGI raises [[trappable error #5]].
-&nbsp;
+Be aware that there is a bug in all versions of AGI affecting the check for valid loop numbers. AGI only returns [[trappable error #5]] if the value of '''vLOOP''' is GREATER than the total number of loops in the view. However, since loops are zero based (first loop is 0, second loop is one, etc.), the last valid loop would be total loop count minus one. If '''vLOOP''' is EQUAL to the loop count, AGI doesn't raise an error, but the loop number is actually invalid, and using it will almost always end up in [[crashing AGI]].
-[[AGI Studio Help File]]
+When the loop changes, AGI checks to see if the current [[cel]] of the screen object is now greater than the last cel in newly assigned loop. If it is, the cel is reset to 0; if not the screen object's cel value is not changed.
-&nbsp;
+== Possible Errors ==
-== See also ==
+In [[version]] 2.089 only, AGI raises [[trappable error #4]] if object number oA is invalid. In all later versions, AGI does not check that object number oA is a valid object. If it is not, this command will overwrite other data on the [[memory heap]], which may cause unexpected results, including possibly [[crashing AGI]].
-* <code>[[set.loop]]</code>
+== Example ==
-&nbsp;
+<div class="CodeBlockHeader">Code:</div>
-[[Category:Object Commands]]
+== Technical Information ==
-[[Category:View Commands]]

Set.loop.v - Revision history

Andrew Korson at 18:29, 21 April 2019

Andrew Branscom: Created page with "set.loop.v == Syntax == set.loop.v(oA,vB); == Description == The current loop of object oA is set to vB. If an i..."

Andrew Branscom: Created page with "set.loop.v ==
Syntax ==
`set.loop.v(oA,vB);`
== Description == The current loop of object oA is set to vB. If an i..."