Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainLibrary::

SampleGround

Blueprint

Ground height, normals, slope, paint and class at one position, the fields asked for.

Declaration

UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Query", meta=(AutoCreateRefTerm="Location", WorldContext="WorldContextObject"))
static FOrreryTerrainGroundSample SampleGround(const UObject* WorldContextObject, const FVector& Location,
                                                 UPARAM(meta=(Bitmask, BitmaskEnum="/Script/OrreryTerrain.EOrreryTerrainSampleFields")) int32 Fields,
                                                 EOrreryTerrainAccuracy Accuracy = EOrreryTerrainAccuracy::Best,
                                                 EOrreryTerrainSurface Surface = EOrreryTerrainSurface::Modified);
Blueprint Sample Ground
The graph as text
  1. Sample Ground (function call)
    • In Location (Vector): (0.0, 0.0, 0.0)
    • In Fields (Integer): 0
    • In Accuracy (EOrreryTerrainAccuracy): Best
    • In Surface (EOrreryTerrainSurface): Modified
    • Out Return Value (OrreryTerrainGroundSample): 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
Sample Ground, in Orrery › Terrain › Query

Parameters

NameTypeDefaultMeaning
WorldContextObjectconst UObject*—

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

Locationconst FVector&—

World cm; Z is ignored.

Fieldsint32—

A bit mask of EOrreryTerrainSampleFields; the height is always computed.

AccuracyEOrreryTerrainAccuracyEOrreryTerrainAccuracy::Best

Best, ExactOnly or Coarse (EOrreryTerrainAccuracy).

SurfaceEOrreryTerrainSurfaceEOrreryTerrainSurface::Modified

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

Returns

The sample; Precision says whether it is an answer.