ProtoTwin API
    Preparing search index...

    Class Sequence

    Represents a sequence of operations.

    Index

    Constructors

    • Constructor.

      Parameters

      • cycle: boolean = false

        Whether the sequence should automatically cycle.

      Returns Sequence

    Accessors

    • get complete(): boolean

      Whether the sequence has completed.

      Returns boolean

    • get cycle(): boolean

      Whether the sequence should automatically cycle.

      Returns boolean

    • set cycle(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

    • Creates a future that resolves once the sequence completes.

      Returns Future<void>

      The future.

      CAUTION! If the sequence is started before obtaining the completion future, it is possible that the sequence may complete before this function is executed. It is recommended to use Sequence.run instead, which obtains the completion before the sequence is started.

    • Pauses the sequence after the current operation has completed.

      Returns void

    • Resets the sequence so that it is ready to be started again.

      Returns void

    • Immediately restarts the sequence.

      Returns void

    • Resumes the sequence after it has been paused.

      Returns void

    • Starts the sequence and returns a future that resolves when the sequence has completed.

      Returns Future<void>

      The future that resolves when the sequence has completed.

    • Starts the sequence.

      Returns void