Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainSubsystem::

CreateTerrain

Create the terrain from a host actor's source, settings and material.

Declaration

bool CreateTerrain(AOrreryTerrainActor& InHost);
Header
#include "OrreryTerrainSubsystem.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Every member function is game thread unless it says otherwise. (the rule of UOrreryTerrainSubsystem)

Description

Bakes the source asset into a Tier-1 ITileSource, builds the FTerrainWorld, starts streaming and the chunk manager, registers the ground provider (when the settings ask for it) and broadcasts OnTerrainCreated. In an editor world the terrain is read-only.

Called by AOrreryTerrainActor at BeginPlay (Game, PIE) or when it is registered in an editor world.

Parameters

NameTypeDefaultMeaning
InHostAOrreryTerrainActor&——

Returns

false, with a warning and nothing created, if this world already has a terrain, the host belongs to another world, or its source asset is missing or incomplete.