Skip to content
Brass Orrery

Orrery Terrain · Blueprint category

Orrery › Terrain › Tool

The nodes the palette lists under Orrery › Terrain › Tool.

  • Begin Stroke

    Open a stroke at the cursor and apply its first step.

    function call · Target is Orrery Terrain Brush Tool Component
  • Cycle Brush Kind

    Step through BrushKinds, wrapping.

    function call · Target is Orrery Terrain Brush Tool Component
  • Cycle Falloff

    Step through the falloff shapes Smooth, Linear, Constant, wrapping.

    function call · Target is Orrery Terrain Brush Tool Component
  • Cycle Paint Layer

    Step through the paint layers, wrapping.

    function call · Target is Orrery Terrain Brush Tool Component
  • End Stroke

    Close the open stroke.

    function call · Target is Orrery Terrain Brush Tool Component
  • Event DrawToolHUD

    Draws the HUD text and the cursor ring on the player's canvas, once per frame while the tool is active.

    event
  • Get Hud Rect

    The rectangle the tool's text and falloff plot covered in the last HUD draw, canvas pixels; invalid when nothing was drawn.

    pure function · Target is Orrery Terrain Brush Tool Component
  • Get HUDLines

    The HUD text, one entry per line, as the default HUD shows it.

    pure function · Target is Orrery Terrain Brush Tool Component
  • Get Sculpt Component

    The sculpt component the tool drives; added to the owner on first use when it has none.

    function call · Target is Orrery Terrain Brush Tool Component
  • Get Tool State

    A snapshot of the tool for a HUD of your own.

    pure function · Target is Orrery Terrain Brush Tool Component
  • Is Pointer Blocked

    Whether SetPointerBlocked holds the stroke key back now.

    pure function · Target is Orrery Terrain Brush Tool Component
  • Is Scripted Stroke Running pure function · Target is Orrery Terrain Brush Tool Component
  • Is Tool Active pure function · Target is Orrery Terrain Brush Tool Component
  • Redo

    Redo the stroke the last Undo took back.

    function call · Target is Orrery Terrain Brush Tool Component
  • Scale Radius

    Multiply the radius by Factor, clamped to the terrain's sculpt limits (at least 1 m).

    function call · Target is Orrery Terrain Brush Tool Component
  • Scale Strength

    Multiply the strength by Factor, clamped to the terrain's sculpt limits (at least 1 cm).

    function call · Target is Orrery Terrain Brush Tool Component
  • Set Brush Kind

    Select a brush kind.

    function call · Target is Orrery Terrain Brush Tool Component
  • Set Falloff

    Select the falloff toward the brush edge, for every brush kind.

    function call · Target is Orrery Terrain Brush Tool Component
  • Set Falloff Start

    Set where the falloff starts: the inner part of the radius at full strength, for the current brush kind (Flatten keeps its own, every other kind shares one).

    function call · Target is Orrery Terrain Brush Tool Component
  • Set Paint Layer

    Select the paint layer the Paint brush writes.

    function call · Target is Orrery Terrain Brush Tool Component
  • Set Pointer Blocked

    Keep the stroke key from opening a stroke, and hide the ring: for a game whose pointer is over its own HUD, or busy turning the view.

    function call · Target is Orrery Terrain Brush Tool Component
  • Set Tool Active

    Turn the tool on or off.

    function call · Target is Orrery Terrain Brush Tool Component
  • Start Scripted Stroke

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

    function call · Target is Orrery Terrain Brush Tool Component
  • Step Falloff Start

    Move the falloff start by one FalloffStartStep, snapped to the step, between 0 and 1 - step.

    function call · Target is Orrery Terrain Brush Tool Component
  • Undo

    Undo the newest stroke (ends an open one first).

    function call · Target is Orrery Terrain Brush Tool Component