Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainEditor module · struct

FOrreryTerrainEdToolDesc

Editor only

A tool the mode lists in a palette.

Declaration

struct FOrreryTerrainEdToolDesc
Header
#include "Mode/OrreryTerrainEdExtensionV1.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.

Description

The mode registers it with its tool manager when entered.

Properties

NameTypeDefaultMeaning
IdFName—

Unique tool id, also the tool manager's identifier.

PaletteFName—

The palette it appears in; a palette that does not exist is created.

LabelFText——
TooltipFText——
IconFSlateIcon——
Orderint320

Position inside the palette, ascending; ties break by Id.

bRequiresTerrainbooltrue

Disabled while the world has no terrain.

MakeBuilderTFunction<UInteractiveToolBuilder*(UEdMode&)>—

Builder owned by the tool manager once registered; the mode is the outer for NewObject.