MaskPropertyGroup object

app.project.item(index).layer(index).mask
Description

The MaskPropertyGroup object encapsulates mask attributes in a layer.

- MaskPropertyGroup is a subclass of PropertyGroup. All methods and attributes of PropertyBase and

PropertyGroup, in addition to those listed below, are available when working with MaskPropertyGroup. See

“PropertyBase object” on page 148 and “PropertyGroup object” on page 155.

Attributes
MaskPropertyGroup color attribute
app.project.item(index).layer(index).mask(index).color
Description

The color used to draw the mask outline as it appears in the user interface (Composition panel, Layer panel,

and Timeline panel).

Type

Array of three floating-point values, [R, G, B], in the range [0.0..1.0]; read/write.

MaskPropertyGroup inverted attribute
app.project.item(index).layer(index).mask(index).inverted
Description

When true, the mask is inverted; otherwise false.

Type

Boolean; read/write.

Attribute Reference Description
maskMode “MaskPropertyGroup maskMode attribute”
on page 107
The mask mode.
inverted “MaskPropertyGroup inverted attribute” on
page 106
When true, the mask is inverted.
rotoBezier “MaskPropertyGroup rotoBezier attribute”
on page 108
When true, the shape of the mask is RotoBezier.
maskMotionBlur “MaskPropertyGroup maskMotionBlur attri-
bute” on page 107
How motion blur is applied to this mask.
locked “MaskPropertyGroup locked attribute” on
page 107
When true, the mask is locked.
color “MaskPropertyGroup color attribute” on
page 106
The color used to draw the mask outline in the user
interface.
maskFeatherFalloff “MaskPropertyGroup maskFeatherFalloff
attribute” on page 107
The feather falloff mode for the mask.

107

After Effects scripting reference MaskPropertyGroup object
MaskPropertyGroup locked attribute
app.project.item(index).layer(index).mask(index).locked
Description

When true, the mask is locked and cannot be edited in the user interface; otherwise, false.

Type

Boolean; read/write.

MaskPropertyGroup maskFeatherFalloff attribute
app.project.item(index).layer(index).mask(index).maskFeatherFalloff
Description

The feather falloff mode for the mask. Equivalent to the Layer > Mask > Feather Falloff setting.

Type

A MaskFeatherFalloff enumerated value; read/write. One of:

MaskFeatherFalloff.FFO_LINEAR
MaskFeatherFalloff.FFO_SMOOTH
MaskPropertyGroup maskMode attribute
app.project.item(index).layer(index).mask(index).maskMode
Description

The masking mode for this mask.

Type

A MaskMode enumerated value; read/write. One of:

MaskMode.NONE
MaskMode.ADD
MaskMode.SUBTRACT
MaskMode.INTERSECT
MaskMode.LIGHTEN
MaskMode.DARKEN
MaskMode.DIFFERENCE
MaskPropertyGroup maskMotionBlur attribute
app.project.item(index).layer(index).mask(index).maskMotionBlur
Description

How motion blur is applied to this mask.

108

After Effects scripting reference MaskPropertyGroup object
Type

A MakMotionBlur enumerated value; read/write. One of:

MaskMotionBlur.SAME_AS_LAYER
MaskMotionBlur.ON
MaskMotionBlur.OFF
MaskPropertyGroup rotoBezier attribute
app.project.item(index).layer(index).mask(index).rotoBezier
Description

When true, the mask is a RotoBezier shape; otherwise, false.

Type

Boolean; read/write.