SequencerClearCommand Object


Description:

Removes all commands from the sequencer or specified loop command.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

SequencerClearCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
ClearCleanupCommand

Whether the commands in the sequencer cleanup routine should also be removed.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Remove all commands from sequencer cleanup routine.

FALSE

Don't remove any commands from sequencer cleanup routine.

CommandParent

Handle of SequencerLoopCommand to clear.

Type: handle

Default: 0

DoDestroy

Whether the command object should be destroyed after it is deleted from the sequencer.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Destroys the command object after it is deleted from sequencer.

FALSE

Doesn't destroy command object after it is deleted from sequencer.

SequencerClearCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status