beginPaintStroke

beginPaintStroke(grid, stroke, baseOf): StrokeRun

Starts a Paint stroke on the grid with its points so far, and returns the run that adds each next one; see applyPaintStroke.

Parameters

Parameter	Type
grid	PaintGrid
stroke	{ clear: boolean; erase: boolean; families?: ScatterFamily[]; level?: number; lower: boolean; material?: string; multiplier?: number; points: [number, number][]; radius: number; shape: "circle" | "square"; strength: number; tool: "paint" | "smooth" | "scatter" | "sculpt" | "flatten"; }
stroke.clear	boolean
stroke.erase	boolean
stroke.families?	ScatterFamily[]
stroke.level?	number
stroke.lower	boolean
stroke.material?	string
stroke.multiplier?	number
stroke.points	[number, number][]
stroke.radius	number
stroke.shape	"circle" | "square"
stroke.strength	number
stroke.tool	"paint" | "smooth" | "scatter" | "sculpt" | "flatten"
baseOf	(cell) => string

Returns

StrokeRun