Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · member function

UOrreryTerrainSampleBatchAsync::

SampleGroundBatchAsync

Blueprint

Declaration

UFUNCTION(BlueprintCallable, Category="Orrery|Terrain|Query", meta=(AutoCreateRefTerm="Locations", BlueprintInternalUseOnly="true", WorldContext="WorldContextObject", DisplayName="Sample Ground Batch (Async)"))
static UOrreryTerrainSampleBatchAsync* SampleGroundBatchAsync(const UObject* WorldContextObject, const TArray<FVector>& Locations,
                                                                UPARAM(meta=(Bitmask, BitmaskEnum="/Script/OrreryTerrain.EOrreryTerrainSampleFields")) int32 Fields,
                                                                EOrreryTerrainAccuracy Accuracy = EOrreryTerrainAccuracy::Best,
                                                                EOrreryTerrainSurface Surface = EOrreryTerrainSurface::Modified, float Timeout = 30.f);
Blueprint Sample Ground Batch (Async)
The graph as text
  1. Sample Ground Batch (Async) (latent function)
    • In Locations (array of Vector): not connected
    • In Fields (Integer): 0
    • In Accuracy (EOrreryTerrainAccuracy): Best
    • In Surface (EOrreryTerrainSurface): Modified
    • In Timeout (Float): 30.0
    • Then: not connected
    • On Completed: not connected
    • On Failed: not connected
    • Out Samples (array of OrreryTerrainGroundSample): not connected
    • Out Reason (EOrreryTerrainAsyncFailure): not connected
Header
#include "OrreryTerrainAsyncActions.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Stable: changes within a major version only add.
Blueprint
Sample Ground Batch (Async), in Orrery › Terrain › Query

Parameters

NameTypeDefaultMeaning
WorldContextObjectconst UObject*—

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

Locationsconst TArray<FVector>&—

World cm. Up to 65,536; the rest are answered NoData.

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.

Timeoutfloat30.f

Real seconds before OnFailed(Timeout); 0 waits for ever.