Orrery Terrain · OrreryTerrainEditor module · class
FOrreryTerrainEdRegistry
Editor onlyWhere the mode's palettes, tools, actions, layers and brush targets come from.
Declaration
class FOrreryTerrainEdRegistry- Header
#include "Mode/OrreryTerrainEdRegistry.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.
Description
Built-in entries are registered by the module at startup, with the same calls a buyer's or our own editor module makes in StartupModule (and undoes in ShutdownModule). Extensions that must not depend on this module register an IOrreryTerrainEdExtensionV1 as a modular feature instead; the registry pulls their lists whenever the mode is entered or a feature (un)registers. The mode and its toolkit read the registry only; nothing else is hard-wired.
Lists come back in display order: ascending Order, then Id. An id that is already registered is refused.
Brush targets come in two versions that share one id namespace: V1 targets (IOrreryTerrainBrushTarget) receive dabs without a mask, V2 targets (IOrreryTerrainBrushTargetV2, experimental) receive the mask with every dab. An id taken by a V1 target cannot be taken by a V2 target, and the other way round, so one object is never both. Precedence for a duplicate id from extensions: direct entries first (V1 before V2), then extensions in extension id order, V1 before V2.
Game thread, editor only. Not a UObject.
Functions
- Getstatic
The registry; created on first use.
- Shutdownstatic
Destroy the registry.
- RegisterPalette
- RegisterTool
- RegisterAction
- RegisterLayer
- RegisterBrushTarget
- RegisterBrushTargetV2
Register a V2 brush target (experimental).
- UnregisterPalette
- UnregisterTool
- UnregisterAction
- UnregisterLayer
- UnregisterBrushTarget
- UnregisterBrushTargetV2
Remove a directly registered V2 brush target.
- GetPalettes
Palettes in display order, including one implied by a tool or action that names it (label: the id).
- GetTools
- GetActions
- GetLayers
- GetBrushTargets
- GetBrushTargetsV2
The V2 brush targets, direct and from extensions, by ascending id.
- FindTool
- FindAction
- FindBrushTarget
The V1 target of the id; null when the id is unknown or belongs to a V2 target.
- FindBrushTargetV2
The V2 target of the id; null when the id is unknown or belongs to a V1 target.
- RefreshExtensions
Pull the lists of every registered
IOrreryTerrainEdExtensionV1andIOrreryTerrainEdExtensionV2again. - FOrreryTerrainEdRegistry
Properties
| Name | Type | Default | Meaning |
|---|---|---|---|
On | FSimple | — | Fired after any change of the registered lists (direct or extension); the toolkit rebuilds its palettes. |