Orrery Terrain · OrreryTerrain module · member function
UOrreryTerrainSubsystem::
GetGroundHeight
BlueprintGround height at a world position, read from one snapshot, lock-free.
Declaration
UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Query", meta=(="Location"))
bool GetGroundHeight(const FVector& Location, double& OutZ, EOrreryTerrainPrecision& OutPrecision,
EOrreryTerrainSurface Surface = EOrreryTerrainSurface::Modified) const;Blueprint Get Ground Height
The graph as text
- Get Ground Height (pure function; Target is Orrery Terrain Subsystem)
- In Target (self object): self
- In Location (Vector): (0.0, 0.0, 0.0)
- In Surface (EOrreryTerrainSurface): Modified
- Out Out Z (Double): not connected
- Out Out Precision (EOrreryTerrainPrecision): not connected
- Out Return Value (Boolean): not connected
- 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)
- Blueprint
- Get Ground Height, in Orrery › Terrain › Query
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
Location | const FVector& | — | World position, cm; Z is ignored. |
OutZ | double& | — | World Z of the ground, cm. |
OutPrecision | EOrrery | — | Exact, Approximate (mip pyramid) or NoData. |
Surface | EOrrery | EOrrery | Which ground to read: Modified (the default) is the ground as edited. |
Returns
false when OutPrecision is NoData (outside the terrain, or no terrain).