Orrery Terrain · OrreryTerrain module · struct

FOrreryTerrainBrushToolState

The brush tool's state, for a HUD and for tests (Tier 3 value, no object references).

Declaration

USTRUCT(BlueprintType)
struct FOrreryTerrainBrushToolState

Blueprint Make and Break Orrery Terrain Brush Tool State

The graph as text

Break Orrery Terrain Brush Tool State (structure)
- In Orrery Terrain Brush Tool State (OrreryTerrainBrushToolState): not connected
- Out Active (Boolean): not connected
- Out Has Terrain (Boolean): not connected
- Out Dragging (Boolean): not connected
- Out Has Cursor (Boolean): not connected
- Out Kind (EOrreryTerrainBrushKind): not connected
- Out Falloff (EOrreryTerrainFalloff): not connected
- Out Falloff Start (Float): not connected
- Out Radius M (Float): not connected
- Out Strength Cm (Float): not connected
- Out Paint Layer (Integer): not connected
- Out Paint Layer Name (Name): not connected
- Out Undo Count (Integer): not connected
- Out Redo Count (Integer): 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 snapshot; stale after the next tool call.
Blueprint: “Orrery Terrain Brush Tool State”, a Blueprint type

Name	Type	Default	Meaning
`bActive`BlueprintReadOnly	`bool`	`false`	The tool owns the input mapping and draws its HUD.
`bHasTerrain`BlueprintReadOnly	`bool`	`false`	The world has a terrain to sculpt.
`bDragging`BlueprintReadOnly	`bool`	`false`	A stroke is open (the stroke button is held, or a scripted stroke runs).
`bHasCursor`BlueprintReadOnly	`bool`	`false`	The cursor ray hit the ground this tick.
`Kind`BlueprintReadOnly	`EOrreryTerrainBrushKind`	`EOrreryTerrainBrushKind::Raise`	—
`Falloff`BlueprintReadOnly	`EOrreryTerrainFalloff`	`EOrreryTerrainFalloff::Smooth`	The brush falloff toward the edge.
`FalloffStart`BlueprintReadOnly	`float`	`0.f`	The inner part of the radius at full strength, 0 to 1 (`FOrreryTerrainBrushBP::FalloffStart`).
`Radius_m`BlueprintReadOnly	`float`	`0.f`	Brush radius, metres.
`Strength_cm`BlueprintReadOnly	`float`	`0.f`	Height change at the centre per brush step, centimetres.
`PaintLayer`BlueprintReadOnly	`int32`	`0`	The paint layer index the Paint brush writes, 0..255.
`PaintLayerName`BlueprintReadOnly	`FName`	—	The paint layer's display name, NAME_None when the names list does not cover the index.
`UndoCount`BlueprintReadOnly	`int32`	`0`	Strokes Undo can take back.
`RedoCount`BlueprintReadOnly	`int32`	`0`	Strokes Redo can put back.