Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · class

UOrreryTerrainStampAsync

Wait until the ground under one brush is editable, then apply it once as a one-dab stroke: a stamp.

Declaration

UCLASS()
class UOrreryTerrainStampAsync : public UOrreryTerrainAsyncBase
Header
#include "OrreryTerrainAsyncActions.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Game thread.
Blueprint
“Orrery Terrain Stamp Async”, a Blueprint type

Description

Any brush kind can stamp (a crater-shaped Lower, a rock-pattern Paint); a height Stamp (Kind Stamp) names a mask as its shape.

It waits as Wait For Terrain Editable does, over the brush's true footprint (the mask's rotated rectangle, which can be kilometres across): it streams that ground in, then begins a stroke, applies the brush and ends the stroke, so one undo takes the stamp back. The mask must be registered with the terrain (UOrreryTerrainSubsystem::RegisterBrush) first.

  • Authority: OnCompleted fires with Applied or NoChange. A brush the terrain refuses (the mask is not registered, the stamp is over the limits, or the kernel for it is not built) fails at once: OnRefused names why, then OnFailed(Refused).

  • Replica: the stamp is a request to the server, and the node completes when the server's next record is applied. The server must hold the mask too (register the brush asset on both); net version 5 carries it to the other clients.

Experimental in v1.0. In C++, create it with StampAsync, bind the pins with AddDynamic, then call Activate.

Note.

Game thread.

Functions

  • StampAsyncBlueprintstatic
  • Beginprotected

    Called once at Activate, with the terrain, before the first Poll.

  • Pollprotected

    Called every frame while waiting.

  • BroadcastFailedprotected

    Fires the node's OnFailed with Reason and the node's failure payload.

Properties

NameTypeDefaultMeaning
OnCompletedBlueprintAssignableFOrreryTerrainStampDelegate—

Fires once the stamp is in: Applied, or NoChange when it changed nothing (a brush wholly outside the ground, a mask of black).

OnRefusedBlueprintAssignableFOrreryTerrainStampDelegate—

Fires before OnFailed(Refused) with the reason in words (Message).

A timeout or a world that ended fires only OnFailed.

OnFailedBlueprintAssignableFOrreryTerrainStampDelegate—

Fires when the node gives up, with Reason; after a refusal Message repeats OnRefused's words.

Blueprint