Skip to content
Orbdale

Orbdale Terrain · OrbdaleTerrainEditor module · member function

FOrbdaleTerrainStampHold::

Begin

Editor only

Begin stamping Stamp on Terrain and try at once.

Declaration

EOrbdaleTerrainStampHoldState Begin(UOrbdaleTerrainSubsystem& Terrain, const FOrbdaleTerrainBrushBP& Stamp, const FText& Label);
Header
#include "Tools/OrbdaleTerrainStampHold.h"
Module
PublicDependencyModuleNames.Add("OrbdaleTerrainEditor"); in an editor module’s Build.cs: an editor module, not in packaged games.
Stability
Stable: changes within a major version only add.
Thread
Game thread, editor only. (the rule of FOrbdaleTerrainStampHold)

Description

A stamp still pending is cancelled first.

Parameters

NameTypeDefaultMeaning
TerrainUOrbdaleTerrainSubsystem&—

The terrain to stamp; the hold keeps a weak reference and its serial.

Stampconst FOrbdaleTerrainBrushBP&—

A Stamp brush whose mask the terrain holds (RegisterBrush), world cm and degrees.

Labelconst FText&—

The undo entry's name.

Returns

The state after the first try.