Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · enum

Native::

ETerrainNetRecordKind

Experimental

What a net record carries.

Declaration

enum class ETerrainNetRecordKind : uint8_t
Header
#include "Native/Net/NetRecord.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

Serialised as one byte; append only.

Values

ValueMeaning
Sculpt = 0

A command: one FSculptCommand (BeginStroke, Brush or EndStroke), kSculptCommandBytes as EncodeSculptCommand writes them. Replayed.

SculptPatch

State: one FSculptPatch (UndoPatch or RedoPatch) as EncodeSculptPatch writes it.

FeatureOps

State: FFeatureOpsRecord, the stack ops one commit applied (EncodeFeatureOps).

Checkpoint

Check: FTerrainCheckpoint, the hashes a replica compares at this position (EncodeCheckpoint).

Repair

State for one client: FTerrainNetRepair (EncodeRepair). Unsequenced: it never enters the log.

Reset

Control: FTerrainNetReset; the authority loaded a save or recreated the terrain, and every replica rejoins.

FieldPatch

Reserved for per-cell fields (climate); this version refuses it.

BrushMask

A brush mask the session uses (net version 5): its hash and canonical bytes (FNetBrushMask, EncodeBrushMaskRecord), or its hash only.

The authority appends it the first time a record names the mask, before that record, so every replica holds the mask before it needs it. Replayed: it adds the mask to the replica's FBrushMaskRegistry and changes no ground.

MaskUpload

Requests only (net version 5): one part of a client's brush mask upload (FNetMaskUpload, EncodeMaskUpload).

A client sends it in its request batches; the server answers it, never logs it, and no record stream carries it. An accepted upload reaches the replicas as an ordinary BrushMask record.