Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainSubsystem::

ApplyBrush

Blueprint

Apply one brush step, stated in world cm, under the sculpt limits.

Declaration

UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Sculpt")
EOrreryTerrainSculptResult ApplyBrush(int64 Stroke, const FOrreryTerrainBrushBP& Brush);
Blueprint Apply Brush
The graph as text
  1. Apply Brush (function call; Target is Orrery Terrain Subsystem)
    • In Target (self object): self
    • In Stroke (Integer64): 0
    • In Brush (OrreryTerrainBrushBP): not connected
    • Out Return Value (EOrreryTerrainSculptResult): not connected
Header
#include "OrreryTerrainSubsystem.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Every member function is game thread unless it says otherwise. (the rule of UOrreryTerrainSubsystem)
Blueprint
Apply Brush, in Orrery › Terrain › Sculpt

Description

Heights publish every applied step; collision swaps and proxy re-creates are throttled to FOrreryTerrainRuntimeSettings::SculptRefreshHz, plus once at EndStroke. An applied step (Applied or NoChange) is broadcast as a record. A step over ground that is still loading answers Pending and is dropped: nothing changes and nothing is sent, and the ground under it is requested, so the same step applies once it has arrived. GetEditAccessAt, or the Wait For Terrain Editable node, says beforehand whether a brush there would apply.

A Refused step never applies: retrying it changes nothing. The first refusal of a stroke for a reason logs a Warning naming the value and the limit (a 120 m brush against the default 100 m Max Radius, for example); GetSculptLimits returns the limits.

Parameters

NameTypeDefaultMeaning
Strokeint64——
Brushconst FOrreryTerrainBrushBP&——

Returns

Applied, NoChange, Pending, Refused (the limits: radius, strength, a channel or value a player may not paint), OutOfOrder (not the open stroke), NoTerrain or ReadOnly (an editor world, a replica, or a call from a listener).