Class Script
Extends
CompositionItem.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Script()
Represents a Script within the Composition.
|
| Field Attributes | Field Name and Description |
|---|---|
| {boolean} |
If true, this Script will be stopped before it's normal completion if the
user presses the "Stop" button (or
$context.composition.stop()
is used). |
| {String} |
The value "Script".
|
- Fields borrowed from class CompositionItem:
- children, completionType, failureText, forEachValue, hasErrorEvents, index, name, nextItem, parent, path, playNumber, playNumberBeforeRenewal, playNumberWithinRenewal, previousItem, propertyList, REPEAT_DISTRIBUTION_CONSTANT, REPEAT_TIMING_PARALLEL, REPEAT_TIMING_SERIAL, REPEAT_TYPE_COUNT_CONSTANT, repeatIndex, systemPropertyList
- Methods borrowed from class CompositionItem:
- clearRepeat, end, endRepeat, getChild, getItemViaPath, setRepeat
Field Detail
{boolean}
canBeStopped
If true, this Script will be stopped before it's normal completion if the
user presses the "Stop" button (or
$context.composition.stop()
is used).
If false, this Script will be allowed to complete before the Composition is stopped.
Defaults to true.
Use this property with caution. If it is set to false and the Script contains an infinite loop, the Composition cannot be stopped.
This property can be set and reset at any time during Script execution to create "unstoppable sections" of the Script.
This property can be used for Script objects only. It cannot be used in an expression inside of an "ISSE" or an "If" object.
Example:
$context.currentScript.canBeStopped = true;
- Since:
- Build 6806.15
{String}
type
The value "Script". Read only.