StartScriptedStroke

Run a whole stroke along a straight line with no pointer: for automation, tutorials and tests.

Declaration

UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Tool")
bool StartScriptedStroke(FVector2D FromCm, FVector2D ToCm, int32 Steps);

Blueprint Start Scripted Stroke

The graph as text

Start Scripted Stroke (function call; Target is Orrery Terrain Brush Tool Component)
- In Target (self object): self
- In From Cm (Vector2D): not connected
- In To Cm (Vector2D): not connected
- In Steps (Integer): 0
- Out Return Value (Boolean): not connected

Header: #include "Tools/OrreryTerrainBrushToolComponent.h"
Module: PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability: Stable: changes within a major version only add.
Thread: Game thread, local player only. (the rule of UOrreryTerrainBrushToolComponent)
Blueprint: Start Scripted Stroke, in Orrery › Terrain › Tool

The cursor moves along the ground from FromCm to ToCm over Steps brush steps at the sculpt component's StepRateHz; the stroke ends by itself.

Name	Type	Default	Meaning
`FromCm`	`FVector2D`	—	Start, world XY, cm.
`ToCm`	`FVector2D`	—	End, world XY, cm.
`Steps`	`int32`	—	Brush steps the stroke takes, at least 1.

false when a stroke is open or there is no terrain.