Orrery Terrain · OrreryTerrainEditor module · member function
FOrreryTerrainFeaturePlacement::
Begin
Editor onlyBegin placing Feature on Terrain and try at once.
Declaration
EOrreryTerrainPlacementState Begin(UOrreryTerrainSubsystem& Terrain, OrreryTerrain::Native::FFeature Feature, const FText& Label, bool bEvaluate = false);- 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. |
Feature | Orrery | — | The feature, owner set; Id 0 adds it, else it replaces that feature in place. |
Label | const FText& | — | The edit's name: the undo record's and the log's. |
bEvaluate | bool | false | Evaluate the earthworks just before the commit (GetEarthworks), as the library reports them. |
Returns
Committed when the ground was loaded, else Pending or Refused.