Orrery Terrain · OrreryTerrainEditor module · member function
FOrreryTerrainStampHold::
Begin
Editor onlyBegin stamping Stamp on Terrain and try at once.
Declaration
EOrreryTerrainStampHoldState Begin(UOrreryTerrainSubsystem& Terrain, const FOrreryTerrainBrushBP& Stamp, const FText& Label);- Header
#include "Tools/OrreryTerrainStampHold.h"- Module
PublicDependencyModuleNames.Add("OrreryTerrainEditor");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 FOrreryTerrainStampHold)
Description
A stamp still pending is cancelled first.
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
Terrain | UOrrery | — | The terrain to stamp; the hold keeps a weak reference and its serial. |
Stamp | const FOrrery | — | A Stamp brush whose mask the terrain holds (RegisterBrush), world cm and degrees. |
Label | const FText& | — | The undo entry's name. |
Returns
The state after the first try.