Start.cycling

From AGI Wiki
Revision as of 22:05, 22 April 2019 by Andrew Korson (Talk | contribs) (Created page with "The '''start.cycling''' command begins cycling a screen object based on its current cycle mode. == Syntax == start.cycling(obj oA); == Remarks == If cy...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The start.cycling command begins cycling a screen object based on its current cycle mode.

Syntax

start.cycling(obj oA);

Remarks

If cycling of screen object oA has been previously stopped, the start.cycling command resumes cycling of the object based on the object's current cycle mode. The cycle mode is not changed.

Use the stop.cycling command to disable an object's cycling property.

Possible Errors

AGI does not check that object number oA is a valid screen object. If it is not, this command will overwrite other data on the memory heap, which may cause unexpected results, including possibly crashing AGI.

Example

Code:
#define tv o7
...  [ initialize object
stop.cycling(tv);   [ tv is paused
...
start.cycling(tv);  [ resume playback

Technical Information

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

See Also

stop.cycling