Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · struct

Native::

FSculptCommand

Experimental

One sculpt command, the unit that replicates a stroke.

Declaration

struct FSculptCommand
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.

Description

Fixed point and relative to the terrain origin: the authority converts Unreal units to an FBrush once, and every replica applies these integers with the integer kernel, so the same commands in the same order write the same posts everywhere. Every field is an integer.

Produced by the authority only (the server, or the local game without a server), after it validated and applied the step; a replica applies it through FSculptReplayer and never skips one. Tier 1, plain data.

Properties

NameTypeDefaultMeaning
Versionuint16_tkSculptRecordVersion—
KindESculptRecordKindESculptRecordKind::Brush

BeginStroke, Brush or EndStroke; a patch kind is invalid here.

StrokeFStrokeId0

The authority's stroke id. Replicas map it to their own.

Stepuint32_t0

Brush: 0-based index within the stroke; a gap is a desync. 0 otherwise.

BrushFBrush—

Brush only. Millimetres relative to the terrain origin.