Orrery Terrain · OrreryTerrainEditor module · struct

FOrreryTerrainSculptBrushSettings

Editor only

What the target applies with every dab, beside the dab's own position, radius and strength.

Declaration

struct FOrreryTerrainSculptBrushSettings

Header: #include "Tools/OrreryTerrainSculptTarget.h"
Module: PublicDependencyModuleNames.Add("OrreryTerrainEditor"); in an editor module’s Build.cs: an editor module, not in packaged games.
Stability: Stable: changes within a major version only add.

Functions

IsSplat
Whether a dab is a splat dab.

Properties

Name	Type	Default	Meaning
`Kind`	`EOrreryTerrainBrushKind`	`EOrreryTerrainBrushKind::Raise`	Raise, Lower, Smooth or Flatten (an inverted dab swaps Raise and Lower); Paint (not inverted: a post holds two layers, and a layer alone has nothing to give way to); or PaintChannel on the ground class (an inverted dab writes FillClass where the value is the hole).
`Falloff`	`EOrreryTerrainFalloff`	`EOrreryTerrainFalloff::Smooth`	—
`FalloffStart`	`double`	`0.0`	Inner part of the radius at full strength, 0 to 1.
`StepHeight_cm`	`double`	`25.0`	Height change at the centre per step at strength 1, cm.
`bFlattenToDab`	`bool`	`false`	Flatten: target each dab's own ground height instead of FlattenTo_cm.
`FlattenTo_cm`	`double`	`0.0`	Flatten: target world Z, cm.
`FlattenDirection`	`EOrreryTerrainFlattenDirection`	`EOrreryTerrainFlattenDirection::Both`	—
`PaintLayer`	`int32`	`0`	Paint: the layer, 0 to 15 (entry N of the terrain's `UOrreryTerrainLayerSet`).
`PaintOpacity`	`double`	`1.0`	Paint: the weight the layer moves toward, 0 to 1.
`Channel`	`int32`	`0`	PaintChannel: the channel (Channels::GroundClass for the ground class and holes).
`ChannelValue`	`uint8`	`0`	PaintChannel: the value; kTerrainHoleClass cuts a hole.
`FillClass`	`uint8`	`0`	PaintChannel, inverted dab of a hole: the class that fills it.
`Mask`	`FOrreryTerrainBrushMaskId`	—	The brush mask, registered with the terrain by the tool; invalid is the round brush and the fields below are then ignored.
`MaskAngle_deg`	`double`	`0.0`	The base angle, degrees from +X toward +Y; RotationMode turns each dab from it.
`RotationMode`	`EOrreryTerrainMaskRotation`	`EOrreryTerrainMaskRotation::Fixed`	—
`AngleJitter_deg`	`double`	`180.0`	Random: each dab turns up to this far either way, drawn from (stroke, step).
`bMirror`	`bool`	`false`	Mirror the mask left to right before the rotation.
`bSquare`	`bool`	`false`	The footprint is the mask's own rotated square instead of the disc.
`MaskAspect`	`double`	`1.0`	The mask's width over its height (`FOrreryTerrainBrushBP::MaskAspect`).
`Splat`	`FOrreryTerrainSplat`	—	A registered splat: when it is valid and Kind is Paint, each dab is ApplySplat (up to four masked Paint steps) and the mask fields above shape it (angle, rotation mode, mirror, square), while Mask and PaintLayer are ignored.
`ExtensionTargets`	`TArray<FName>`	—	Registry ids of extension brush targets (V1 or V2) that every dab of a stroke is also sent to; V2 targets get the mask and the dab's resolved angle, V1 targets the plain dab. Empty drives none.