Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainEditor module · member function

FOrreryHeightmapSidecar::

Parse

Editor only

Decode and check a sidecar.

Declaration

static bool Parse(const FString& Json, bool bIsRaw, FOrreryHeightmapSidecar& Out, FString& OutError);
Header
#include "OrreryTerrainHeightmapImport.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrainEditor"); in an editor module’s Build.cs: an editor module, not in packaged games.
Stability
Stable: changes within a major version only add.

Parameters

NameTypeDefaultMeaning
Jsonconst FString&—

The sidecar's text.

bIsRawbool—

true for a RAW heightmap, which must then name its size.

OutFOrreryHeightmapSidecar&—

Receives the sidecar; untouched on failure.

OutErrorFString&—

Why the sidecar was refused; untouched on success.

Returns

false for malformed JSON, a wrong type, a missing or contradictory field, a non-square size, a spacing outside 0.25..16 m, a non-positive or absurd height scale, or an unknown raster kind.