effect
Effect
Section titled “Effect”thisLayer.effect("Bulge")
This category contains information relating to Effects.
On this page, we’re going to use thisLayer.effect("Bulge")
as a sample on how to call these items, however note that any method that returns an Effect will work.
Attributes
Section titled “Attributes”Effect.active
Section titled “Effect.active”thisLayer.effect("Bulge").active
Description
Section titled “Description”Returns true
if the effect is turned on (the effect switch is selected).
Boolean
Methods
Section titled “Methods”Effect.param()
Section titled “Effect.param()”thisLayer.effect("Bulge").param(name)
thisLayer.effect("Bulge").param(index)
Description
Section titled “Description”Returns a property within an effect. Effect control points are always in layer space.
This method can be called using either the property’s name
or its index
.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
name | String | Property name or index to access property by. |
index | Number |
Returns
Section titled “Returns”Example
Section titled “Example”To return the “Bulge Height” property from the “Bulge” effect by name:
thisLayer.effect("Bulge").param("Bulge Height");
To return the “Bulge Height” property from the “Bulge” effect by index:
thisLayer.effect("Bulge").param(4);