new RemoveBackgroundAction()

Description

A class that defines how to remove the background of an asset

Details

Visit Effect for an example

Methods


getActionTag() → {string}

Description

Returns the custom name tag that was given to this action

Returns

setActionTag() → {this}

Description

Sets the custom name tag for this action

Returns

toString() → {string}

Description

Calls toString() on all child qualifiers (implicitly by using .join()).

Returns
Details

addQualifier( qualifier ) → {this}

Description

Adds the parameter to the action.

Parameters
Name Type Description
qualifier SDK.Qualifier
Returns

addFlag( flag ) → {this}

Description

Adds a flag to the current action.

Parameters
Name Type Description
flag Qualifiers.Flag
Returns
Details

screen( useScreen ) → {this}

Description

The strength of the shadow. (Range: 0 to 100, Server default: 40)

Parameters
Name Type Default Description
useScreen number true

Boolean, defaults to true

Returns

colorToRemove( color ) → {this}

Description

The color to remove from the background

Parameters
Name Type Description
color SystemColors
Returns