Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · function

Native::

DecodeSculptPatch

Experimental

Read a patch written by EncodeSculptPatch.

Declaration

bool DecodeSculptPatch(const uint8_t* Data, size_t Size, FSculptPatch& Out);
Header
#include "Native/SculptCommand.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrainCore"); in your module’s Build.cs.
Stability
Experimental: supported, may change in a minor version, with a changelog line.
Thread
Pure, any thread.

Description

A version 2 patch has this version's layout and comes back as this version.

Parameters

NameTypeDefaultMeaning
Dataconst uint8_t*——
Sizesize_t——
OutFSculptPatch&——

Returns

false, with Out untouched, when malformed: an unknown version, a command kind, a length that disagrees with Size, or tile bytes that do not decode. Tiles are checked against a terrain's extent only when FTerrainWorld::ApplySculptPatch applies them.

Note.

Pure, any thread.