- Source:
Methods
(static) activeComp(undoGroup, callback) → {Boolean|Any}
- Source:
Gets the active comp and alerts the user if no comp is open. It then creates an undo group and executes a callback function with the comp as the first argument.
Parameters:
| Name | Type | Description |
|---|---|---|
undoGroup |
String | Name of the undo group |
callback |
function | Function to execute that gets the active comp as the first argument |
Returns:
false if the function is not executed
because no comp was selected. Else the value the callback
function returns is returned.
- Type
- Boolean | Any
(static) forEachSelectedLayer(undoGroup, callback) → {Boolean|ArrayEx}
- Source:
Loops through the selected layers in the active comp. Alerts the user if no comp is open, or no layer is selected. It then creates an undo group and executes a callback function for each of the layers.
Parameters:
| Name | Type | Description |
|---|---|---|
undoGroup |
String | Name of the undo group. |
callback |
forEachArrayCallback | Function to execute for each layer. |
Returns:
false if the function is not executed because
no comp was open or no layer selected. Else the layers array is
returned.
- Type
- Boolean | ArrayEx
(static) forEachSelectedLayerOrAll(undoGroup, callback) → {Boolean|ArrayEx}
- Source:
Loops through the selected layers or all layers if no layers are selected, in the active comp. Alerts the user if no comp is open. It then creates an undo group and executes a callback function for each of the layers.
Parameters:
| Name | Type | Description |
|---|---|---|
undoGroup |
String | Name of the undo group |
callback |
forEachArrayCallback | Function to execute for each layer. |
Returns:
false if the function is not executed
because no comp was open. Else
the layers array are returned.
- Type
- Boolean | ArrayEx
(static) forEachSelectedProperty(undoGroup, callback) → {Boolean|ArrayEx}
- Source:
Loops through the selected properties in the active comp. Alerts the user if no comp is open, or no properties is selected. It then creates an undo group and executes a callback function for each of the properties.
Parameters:
| Name | Type | Description |
|---|---|---|
undoGroup |
String | Name of the undo group |
callback |
forEachArrayCallback | Function to execute for each property. |
Returns:
false if the function is not executed
because no comp was open or no layer
selected. Else the property array
is returned.
- Type
- Boolean | ArrayEx
(static) selectedLayers(undoGroup, callback) → {Boolean|Any}
- Source:
Gets the selected layers in the active comp and alerts the user if no comp is open, or if no layer is selected. It then creates an undo group and executes a callback function with the layers as the first argument, and the comp as the second argument.
Parameters:
| Name | Type | Description |
|---|---|---|
undoGroup |
String | Name of the undo group |
callback |
function | Function to execute that gets the selected layers as the first argument, and the comp as the second argument. |
Returns:
false if the function is not executed because
no comp or layer was selected. Else the value the callback function
returns is returned.
- Type
- Boolean | Any
(static) selectedLayersOrAll(undoGroup, callback) → {Boolean|Any}
- Source:
Gets the selected layers or all layers if no layers are selected, in the active comp. Alerts the user if no comp is open. It then creates an undo group and executes a callback function with the layers as the first argument, and the comp as the second argument.
Parameters:
| Name | Type | Description |
|---|---|---|
undoGroup |
String | Name of the undo group. |
callback |
function | Function to execute that gets the selected layers in an ArrayEx as the first argument, and the comp as the second argument. |
Returns:
false if the function is not executed because
no comp was open. Else the value the callback function is returned.
- Type
- Boolean | Any
(static) selectedProperties(undoGroup, callback) → {Boolean|Any}
- Source:
Gets the selected properties in the active comp and alerts the user if no comp is open, or if no property is selected. It then creates an undo group and executes a callback function with the properties as the first argument, and the comp as the second argument.
Parameters:
| Name | Type | Description |
|---|---|---|
undoGroup |
String | Name of the undo group |
callback |
function | Function to execute that gets the selected properties in an ArrayEx as the first argument, and the comp as the second argument. |
Returns:
false if the function is not executed.
because no comp or property was selected. Else the value the callback
function is returned.
- Type
- Boolean | Any