Skip to content
Orbdale

Orbdale Terrain · OrbdaleTerrain module · member function

UOrbdaleTerrainLibrary::

SampleGround

Blueprint

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

Declaration

UFUNCTION(BlueprintCallable, Category="Orbdale|Terrain|Query", meta=(AutoCreateRefTerm="Location", WorldContext="WorldContextObject"))
static FOrbdaleTerrainGroundSample SampleGround(const UObject* WorldContextObject, const FVector& Location,
                                                 UPARAM(meta=(Bitmask, BitmaskEnum="/Script/OrbdaleTerrain.EOrbdaleTerrainSampleFields")) int32 Fields,
                                                 EOrbdaleTerrainAccuracy Accuracy = EOrbdaleTerrainAccuracy::Best,
                                                 EOrbdaleTerrainSurface Surface = EOrbdaleTerrainSurface::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 (EOrbdaleTerrainAccuracy): Best
    • In Surface (EOrbdaleTerrainSurface): Modified
    • Out Return Value (OrbdaleTerrainGroundSample): not connected
Header
#include "OrbdaleTerrainLibrary.h"
Module
PublicDependencyModuleNames.Add("OrbdaleTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Thread
Game thread (Blueprint). (the rule of UOrbdaleTerrainLibrary)
Blueprint
Sample Ground, in Orbdale › 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 EOrbdaleTerrainSampleFields; the height is always computed.

AccuracyEOrbdaleTerrainAccuracyEOrbdaleTerrainAccuracy::Best

Best, ExactOnly or Coarse (EOrbdaleTerrainAccuracy).

SurfaceEOrbdaleTerrainSurfaceEOrbdaleTerrainSurface::Modified

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

Returns

The sample; Precision says whether it is an answer.