Orrery Terrain · OrreryTerrainEditor module · member function
FOrreryTerrainFeaturePlacement::
BeginRemove
Editor onlyBegin removing the feature Id from Terrain and try at once.
Declaration
EOrreryTerrainPlacementState BeginRemove(UOrreryTerrainSubsystem& Terrain, OrreryTerrain::Native::FFeatureId Id, const FText& Label);- Header
#include "Tools/OrreryTerrainFeaturePlacement.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 FOrreryTerrainFeaturePlacement)
Description
A placement still pending is cancelled first.
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
Terrain | UOrrery | — | The terrain to commit to; it must have a terrain world. |
Id | Orrery | — | The feature to remove; 0 is refused. |
Label | const FText& | — | The edit's name: the undo record's and the log's. |
Returns
Committed when the ground was loaded, else Pending or Refused.