Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainSubsystem::

GetGroundHandle

The terrain's any-thread handle (FGroundHandle): keep it in a task, a PCG worker or an extension's simulation and acquire queries there without a hop to the game thread.

Declaration

std::shared_ptr<const OrreryTerrain::Native::FGroundHandle> GetGroundHandle() const;
Header
#include "OrreryTerrainSubsystem.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Game thread; the handle itself is any thread.

Description

Once DestroyTerrain runs, it answers empty queries.

Returns

Null without a terrain. A new terrain (CreateTerrain again) has a new handle.

Note.

C++ only. Game thread; the handle itself is any thread.