Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · function

Native::

PeekSculptRecordKind

Experimental

The kind of an encoded record, from its first three bytes, so a receiver can dispatch.

Declaration

bool PeekSculptRecordKind(const uint8_t* Data, size_t Size, ESculptRecordKind& OutKind);
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.

Parameters

NameTypeDefaultMeaning
Dataconst uint8_t*——
Sizesize_t——
OutKindESculptRecordKind&——

Returns

false on a short buffer, an unknown version (versions kSculptRecordOldestVersion to kSculptRecordVersion are known) or an unknown kind.