Orbdale Terrain · OrbdaleTerrain module · class

UOrbdaleTerrainFollowSettings

Project settings for ground-following foliage (Project Settings, Plugins, Orbdale Terrain Follow).

Declaration

UCLASS(Config=Game, DefaultConfig, meta=(DisplayName="Orbdale Terrain Follow"))
class UOrbdaleTerrainFollowSettings : public UDeveloperSettings

Header: #include "OrbdaleTerrainFollowSettings.h"
Module: PublicDependencyModuleNames.Add("OrbdaleTerrain"); in your module’s Build.cs.
Stability: Stable: changes within a major version only add.
Thread: Game thread.
Derives from: UDeveloperSettings

Description

Placed foliage follows a sculpt or a construction by default: it moves with the ground, and is hidden where the ground no longer admits it (a cutting, a platform, a tunnel mouth, a slope steeper than the foliage type allows). Overrides name a foliage type and a mode.

Tier 3 configuration, read when a foliage actor registers. Game thread. Saved to DefaultGame.ini.

Functions

UOrbdaleTerrainFollowSettings
Getstatic
The project's settings object (the class default object).
ModeFor
The mode for a foliage type: its override, else Follow when bFoliageFollowsGround and Ignore when not.

Properties

Name	Type	Default	Meaning
`bFoliageFollowsGround`	`bool`	`true`	Every foliage actor's instances follow the ground. Off: only components tagged `OrbdaleTerrain.Follow`, and the per-type overrides that say Follow, do.
`FoliageTypeOverrides`	`TMap<TSoftObjectPtr<UFoliageType>, EOrbdaleTerrainFollowMode>`	—	Per foliage type: Follow, HideOnly or Ignore. A type not listed behaves as bFoliageFollowsGround says.
`ClearMargin`	`float`	`0.f`	Extra distance around a feature placed at runtime inside which foliage is cleared, cm.
`FollowTag`	`const FName`	—	The component tag that makes any instanced mesh follow the ground.