Sg2.0
LiveEffect
Packages

Wrapper for Illustrator's LiveEffects. Unfortunatelly, Illustrator is not able to remove once created effects again until the next restart. They can be removed from the menu but not from memory. So In order to recycle effects with the same settings, e.g. during development, where the code often changes but the initial settings maybe not, keep track of all existing effects and match against those first before creating a new one. Also, when Scriptographer is (re)loaded, the list of existing effects needs to be walked through and added to the list of unusedEffects. This is done by calling getUnusedEffects.

Constructors

Parameters:
name: String
title: String
preferedInput: Number - a combination of LiveEffect.INPUT_*
type: Number - one of LiveEffect.TYPE_
flags: Number - a combination of LiveEffect.FLAG_*
majorVersion: Number
minorVersion: Number
Same constructor, but name is used for title and name.
Parameters:
name: String
preferedInput: Number
type: Number
flags: Number
majorVersion: Number
minorVersion: Number

Properties

Returns:
Callable
Returns:
Callable
Returns:
Callable
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
Returns:
Number
TYPE_POST_EFFECT
Returns:
Number
Returns:
Number
Returns:
Number

Functions

Parameters:
cateogry: String
title: String
Returns:
Call only from onEditParameters!
Parameters:
parameters: Object
Returns:
Object
"Removes" the effect. there is no real destroy for LiveEffects in Illustrator, so all it really does is remove the effect's menu item, if there is one. It keeps the effectHandle and puts itself in the list of unused effects
Call only from onEditParameters!
Parameters:
parameters: Object
Returns:
Boolean