Skip to content
Orbdale

Orbdale Terrain · OrbdaleTerrainEditor module · class

UOrbdaleTerrainEditorFollowSubsystem

Editor only

Makes placed foliage, instanced meshes tagged OrbdaleTerrain.Follow and actors with a Terrain Ground Follow component follow the terrain mode's edits in an editor world (UOrbdaleTerrainFollowSubsystem covers game and PIE worlds).

Declaration

UCLASS()
class UOrbdaleTerrainEditorFollowSubsystem : public UWorldSubsystem
Header
#include "Follow/OrbdaleTerrainEditorFollow.h"
Module
PublicDependencyModuleNames.Add("OrbdaleTerrainEditor"); 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 worlds only.
Derives from
UWorldSubsystem

Description

A sculpt, smooth, flatten, paint (holes included), plate, corridor or feature edit made through the mode calls BeginEdit before it writes and FinishEdit after, which applies the follow at once and wraps the edit's change with the follow's record, so one undo or one redo restores the ground and the instances together. The rule is the runtime follow's, measured against the ground just before the edit:

  • an instance keeps its offset from that ground (Follow) or its height (HideOnly), and an aligned foliage instance is aligned again on the new face normal, as the foliage tool aligns it;

  • an instance is hidden where the edit opened a hole, made the ground steeper than its type allows, or placed or changed a feature over it (the clear margin included); it is kept, exactly, until a later edit gives the ground back;

  • an actor moves (Follow) but is never hidden in the editor: one the ground no longer admits is logged instead.

The record holds only what changed, by value: 40 bytes a moved foliage instance, 56 a moved instanced-mesh instance and a few hundred for each hidden or restored one, never a snapshot of the foliage actor or the component (the follow's writes run with GUndo cleared). Hidden instances live in this subsystem for the editor session; a map saved while an edit hides some saves it without them.

Note.

Game thread, editor worlds only. Editor module (Tier 3).

Functions