Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainBrushToolComponent::

SplatAt

Blueprint

Lay the splat once at a place, as a one-dab stroke (one undo): up to four masked Paint steps, red to alpha.

Declaration

UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Tool|Brush")
EOrreryTerrainSculptResult SplatAt(FVector Location, float Angle, float Radius = 0.f);
Blueprint Splat At
The graph as text
  1. Splat At (function call; Target is Orrery Terrain Brush Tool Component)
    • In Target (self object): self
    • In Location (Vector): (0.0, 0.0, 0.0)
    • In Angle (Float): 0.0
    • In Radius (Float): 0.0
    • Out Return Value (EOrreryTerrainSculptResult): 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, local player only. (the rule of UOrreryTerrainBrushToolComponent)
Blueprint
Splat At, in Orrery › Terrain › Tool › Brush

Description

The dab takes the tool brush's falloff, opacity and mask flags; set Constant falloff and Square to lay the image whole.

Parameters

NameTypeDefaultMeaning
LocationFVector—

World cm; XY matter.

Anglefloat—

The splat angle, degrees from +X toward +Y.

Radiusfloat0.f

World cm; 0 keeps the brush radius.

Returns

Applied or NoChange; Pending over ground still loading (the dab is dropped); Refused when the terrain does not hold the masks or the dab is over the limits; NoTerrain, or ReadOnly when no splat is set. On a replica the dab is sent as requests like a stamp (Pending); the server must hold the masks.