CycleTo (of Cycle)

class CycleTo

Defined in Cycle.sc.

CycleTo is a cycler that cycles to a specific cel, then stops.

Example usage:

; Cycle the door forward to cel 4, then stop.
(door setCycle: CycleTo 4 cdFORWARD)

Subclasses: EndLoop, BegLoop.

class diagram

Properties

Inherited from Cycle:

Property Description
name  
client The object to which this is attached.
caller The object that is cue()’d when the cycle is complete.
cycleDir cdFORWARD or cdBACKWARD.
cycleCnt  
completed  

Defined in CycleTo:

Property Description
endCel  

Methods

init(theClient theEndCel theCycleDir [theCaller])
Parameters:
  • theClient (heapPtr) – The Prop to which this is attached.
  • theEndCel (number) – The cel number that we are cycling to.
  • theCycleDir (number) – cdFORWARD or cdBACKWARD.
  • theCaller (heapPtr) – Optional object on which we call cue() when the cycle is finished.
doit()
cycleDone()