Effect

Creates an effect and registers it under its type.

Parameters:

• props: Object — the type of the effect, its label and parameters, and onApply and onEditParameters

Returns:

• Effect

The type that the effect is registered under, and that items use it by.

Read only.

Type:

• String

The label of the effect, for hosts to show to users.

Read only.

Default:

• the type

Type:

• String

The declared parameters of the effect by their names, as objects that describe them for hosts to build their settings from, with the default as their value, e.g. { label: 'Amount', type: 'number', range: [0, 100], value: 10 }. The instances of the effect have them as properties.

Read only.

Type:

• Object

The function that applies the effect, called with the instance as this, and returning what the effect makes of the art that it gets, which it doesn’t change.

Type:

• Function⟋null

Options:

• event.art: Item — the item to apply the effect to, or what the effect before it returned
• event.item: Item — the item that the instance is part of

The function that hosts call when the user edits the parameters of an instance, with the instance as this, to set its properties. Paper.js itself doesn’t call it.

Type:

• Function⟋null

Removes the effect from the registered effects.

Returns:

• Boolean — true if the effect was registered, false otherwise

Registers the effect under its type, replacing any effect registered there before. Effects register themselves when they are created.

Parameters:

• effect: Effect

Returns:

• Effect — the effect

Returns the effect registered under the type.

Parameters:

• type: String

Returns:

• Effect⟋null — the effect, or null

Returns all registered effects.

Returns:

• Array of Effect objects — the effects

Removes the effect from the registered effects.

Parameters:

• effect: Effect

Returns:

• Boolean — true if the effect was registered, false otherwise