Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainEditor module · member function

FOrreryTerrainFeaturePlacement::

Begin

Editor only

Begin 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

NameTypeDefaultMeaning
TerrainUOrreryTerrainSubsystem&—

The terrain to commit to; it must have a terrain world.

FeatureOrreryTerrain::Native::FFeature—

The feature, owner set; Id 0 adds it, else it replaces that feature in place.

Labelconst FText&—

The edit's name: the undo record's and the log's.

bEvaluateboolfalse

Evaluate the earthworks just before the commit (GetEarthworks), as the library reports them.

Returns

Committed when the ground was loaded, else Pending or Refused.