Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainLibrary::

GetGroundHeightRange

Blueprint

Lowest and highest ground within a circle, from the resident tiles.

Declaration

UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Query", meta=(AutoCreateRefTerm="Centre", WorldContext="WorldContextObject"))
static bool GetGroundHeightRange(const UObject* WorldContextObject, const FVector& Centre, double Radius, double& OutMin, double& OutMax,
                                 EOrreryTerrainSurface Surface = EOrreryTerrainSurface::Modified);
Blueprint Get Ground Height Range
The graph as text
  1. Get Ground Height Range (function call)
    • In Centre (Vector): (0.0, 0.0, 0.0)
    • In Radius (Double): 0.0
    • In Surface (EOrreryTerrainSurface): Modified
    • Out Out Min (Double): not connected
    • Out Out Max (Double): not connected
    • Out Return Value (Boolean): not connected
Header
#include "OrreryTerrainLibrary.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Game thread (Blueprint). (the rule of UOrreryTerrainLibrary)
Blueprint
Get Ground Height Range, in Orrery › Terrain › Query

Parameters

NameTypeDefaultMeaning
WorldContextObjectconst UObject*—

Any object in the world whose terrain is read; supplies the world.

Centreconst FVector&—

World cm; Z is ignored.

Radiusdouble—

cm, clamped to 10 to 1,000,000.

OutMindouble&—

World Z of the lowest ground, cm.

OutMaxdouble&—

World Z of the highest ground, cm.

SurfaceEOrreryTerrainSurfaceEOrreryTerrainSurface::Modified

Which ground to read (EOrreryTerrainSurface); Modified is the current ground.

Returns

false when no ground lies under the circle.