Orrery Terrain · OrreryTerrainEditor module · member function
UOrreryTerrainBrushTool::
RegisterMask
Editor onlyRegister Mask's brush asset with Terrain, so a stroke may name it; Disc needs nothing.
Declaration
static bool RegisterMask(UOrreryTerrainSubsystem& Terrain, const UOrreryTerrainBrushMaskProperties* Mask, FText& OutWhyNot);- Header
#include "Tools/OrreryTerrainBrushTool.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 UOrreryTerrainBrushTool)
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
Terrain | UOrrery | — | The terrain the stroke will edit. |
Mask | const UOrrery | — | The tool's brush mask settings; null or Disc registers nothing. |
OutWhyNot | FText& | — | Why the terrain refused the mask (not baked, a hash collision, over the registry's budget). |
Returns
true for Disc, Registered and AlreadyHeld.