Orbdale Terrain · OrbdaleTerrainEditor module · member function
FOrbdaleTerrainBrushStroke::
Begin
Editor onlyPress at Cursor_cm (world cm, on the ground): the target opens a stroke and takes the first dab.
Declaration
bool Begin(UWorld& World, FOrbdaleTerrainSculptHeightTarget& Target, const FOrbdaleTerrainStepperSettings& Stepping, const FVector& Cursor_cm, const FShape& Shape);- Header
#include "Tools/OrbdaleTerrainBrushStroke.h"- Module
PublicDependencyModuleNames.Add("OrbdaleTerrainEditor");in an editor module’s Build.cs: an editor module, not in packaged games.- Stability
- Stable: changes within a major version only add.
- Thread
- Game thread, editor only. (the rule of FOrbdaleTerrainBrushStroke)
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
World | UWorld& | — | — |
Target | FOrbdale | — | — |
Stepping | const FOrbdale | — | — |
Cursor_cm | const FVector& | — | — |
Shape | const FShape& | — | — |
Returns
false when the target refused (ground loading, edits refused, off the terrain): nothing is open.