ComplexStrokeProperties

For nodes using brush or dynamic strokes, node.complexStrokeProperties describes the properties of these stroke types. Nodes that do not use brush or dynamic strokes will have complexStrokeProperties set to {type: 'BASIC'}.

type ComplexStrokeProperties =
  | { type: 'BASIC' }
  | BrushStrokeProperties
  | DynamicStrokeProperties

Brush Strokes

For nodes with brush strokes, node.complexStrokeProperties will have the type BRUSH. There are two types of brushes: stretch brushes and scatter brushes. Stretch brushes stretch a brush pattern along the length of the stroke, while scatter brushes scatter brush shapes along the stroke path. Stretch and scatter brushes each have their own set of properties.

When setting a brush on a stroke, you must first ensure that the desired brush-type brushes are loaded with figma.loadBrushesAsync(). This function only needs to be called once per plugin session; after the brushes are loaded, they can be used on any number of nodes.

Stretch Brushes

Stretch brush strokes have type: 'BRUSH' and brushType: 'STRETCH' with the following additional properties:

brushName: 'HEIST' | 'BLOCKBUSTER' | 'GRINDHOUSE' | 'BIOPIC' | 'SPAGHETTI_WESTERN' | 'SLASHER' | 'HARDBOILED' | 'VERITE' | 'EPIC' | 'SCREWBALL' | 'ROM_COM' | 'NOIR' | 'PROPAGANDA' | 'MELODRAMA' | 'NEW_WAVE' | 'CUSTOM'

Name of the stretch brush. See the available brushes for previews of these brushes. Nodes using custom brushes will have this set to 'CUSTOM'. However, setting this property to 'CUSTOM' is not yet supported.

direction: 'FORWARD' | 'BACKWARD'

The direction of the brush

Scatter Brushes

Scatter brush strokes have type: 'BRUSH' and brushType: 'SCATTER' with the following additional properties:

brushName: 'BUBBLEGUM' | 'WITCH_HOUSE' | 'SHOEGAZE' | 'HONKY_TONK' | 'SCREAMO' | 'DRONE' | 'DOO_WOP' | 'SPOKEN_WORD' | 'VAPORWAVE' | 'OI' | 'CUSTOM'

Name of the scatter brush. See the available brushes for previews of these brushes. Nodes using custom brushes will have this set to 'CUSTOM'. However, setting this property to 'CUSTOM' is not yet supported.

gap: number

Gap between brush instances along the stroke path. Minimum value is 0.25

wiggle: number

The amount of random movement applied to brush instances along the stroke path. The minimum value is 0.

sizeJitter: number

The amount of random size variation applied to brush instances. Ranges from 0 to 3.

angularJitter: number

The amount of random angular variation in degrees applied to brush instances. Ranges from -180 to 180.

rotation: number

The rotation in degrees applied to brush instances. Ranges from -180 to 180.

Custom brushes

Setting custom brushes in the plugin API is not yet supported. However, if an existing node uses a custom brush, node.complexStrokeProperties will return the brush name CUSTOM along with the relevant brush properties.

Available brushes

Stretch brushes

Brush name	Image
`HEIST`
`BLOCKBUSTER`
`GRINDHOUSE`
`BIOPIC`
`SPAGHETTI_WESTERN`
`SLASHER`
`HARDBOILED`
`VERITE`
`EPIC`
`SCREWBALL`
`ROM_COM`
`NOIR`
`PROPAGANDA`
`MELODRAMA`
`NEW_WAVE`