Skip to content
Orbdale

Orbdale Terrain · OrbdaleTerrain module · struct

FOrbdaleTerrainBrushToolState

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

Declaration

USTRUCT(BlueprintType)
struct FOrbdaleTerrainBrushToolState
Blueprint Make and Break Orbdale Terrain Brush Tool State
The graph as text
  1. Break Orbdale Terrain Brush Tool State (structure)
    • In Orbdale Terrain Brush Tool State (OrbdaleTerrainBrushToolState): 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 (EOrbdaleTerrainBrushKind): not connected
    • Out Falloff (EOrbdaleTerrainFalloff): 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/OrbdaleTerrainBrushToolComponent.h"
Module
PublicDependencyModuleNames.Add("OrbdaleTerrain"); 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
“Orbdale Terrain Brush Tool State”, a Blueprint type

Properties

NameTypeDefaultMeaning
bActiveBlueprintReadOnlyboolfalse

The tool owns the input mapping and draws its HUD.

bHasTerrainBlueprintReadOnlyboolfalse

The world has a terrain to sculpt.

bDraggingBlueprintReadOnlyboolfalse

A stroke is open (the stroke button is held, or a scripted stroke runs).

bHasCursorBlueprintReadOnlyboolfalse

The cursor ray hit the ground this tick.

KindBlueprintReadOnlyEOrbdaleTerrainBrushKindEOrbdaleTerrainBrushKind::Raise—
FalloffBlueprintReadOnlyEOrbdaleTerrainFalloffEOrbdaleTerrainFalloff::Smooth

The brush falloff toward the edge.

FalloffStartBlueprintReadOnlyfloat0.f

The inner part of the radius at full strength, 0 to 1 (FOrbdaleTerrainBrushBP::FalloffStart).

Radius_mBlueprintReadOnlyfloat0.f

Brush radius, metres.

Strength_cmBlueprintReadOnlyfloat0.f

Height change at the centre per brush step, centimetres.

PaintLayerBlueprintReadOnlyint320

The paint layer index the Paint brush writes, 0..255.

PaintLayerNameBlueprintReadOnlyFName—

The paint layer's display name, NAME_None when the names list does not cover the index.

UndoCountBlueprintReadOnlyint320

Strokes Undo can take back.

RedoCountBlueprintReadOnlyint320

Strokes Redo can put back.

Blueprint