Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrain module · struct

FOrreryTerrainNetResult

Experimental

The outcome of one request, sent to its client only (ClientRequestResults).

Declaration

USTRUCT(BlueprintType)
struct FOrreryTerrainNetResult
Blueprint Make and Break Orrery Terrain Net Result
The graph as text
  1. Break Orrery Terrain Net Result (structure)
    • In Orrery Terrain Net Result (OrreryTerrainNetResult): not connected
    • Out Request Id (Integer64): not connected
    • Out Kind (EOrreryTerrainEditKind): not connected
    • Out Refusal (EOrreryTerrainNetRefusal): not connected
    • Out Change Seq (Integer64): not connected
    • Out Feature Id (Integer64): not connected
    • Out Earthworks (OrreryTerrainEarthworks): not connected
    • Out Reason (String): not connected
    • Out Mask Hash (Integer64): not connected
    • Out Uploaded Bytes (Integer64): not connected
Header
#include "Net/TerrainNetTypes.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrain"); in your module’s Build.cs.
Stability
Experimental: supported, may change in a minor version, with a changelog line.
Blueprint
“Orrery Terrain Net Result”, a Blueprint type

Description

Accepted brush steps are not answered (their records come back); refusals, undos, redos and feature requests are.

Note.

RequestId 0 names no request. With Refusal Rejoined it is the server's marker that it joins the link again: the client stops reporting itself live and refuses new requests until the next Welcome. The client handles it itself and never stores or broadcasts it. With Refusal Malformed it answers a request batch that did not decode.

Note.

A brush mask upload (Kind AddBrushMask) is answered against its offer's RequestId, up to twice: first with the bytes the server holds (UploadedBytes; all of them when it holds the mask already), then with the outcome: accepted with the BrushMask record (ChangeSeq), or refused. MaskHash names the mask.

Properties

NameTypeDefaultMeaning
RequestIdBlueprintReadOnlyint640

The request's id: its position in the client's request stream.

KindBlueprintReadOnlyEOrreryTerrainEditKindEOrreryTerrainEditKind::Sculpt—
RefusalBlueprintReadOnlyEOrreryTerrainNetRefusalEOrreryTerrainNetRefusal::None

None when accepted.

ChangeSeqBlueprintReadOnlyint640

Accepted: the record that carries the change; the client shows it once it has applied this far.

FeatureIdBlueprintReadOnlyint640

A committed feature's id, in the server's numbering (every machine's).

EarthworksBlueprintReadOnlyFOrreryTerrainEarthworks—

A committed feature's earthworks, as the server priced them.

ReasonBlueprintReadOnlyFString—

Feature refusals: the stack's reason.

MaskHashBlueprintReadOnlyint640

A brush mask upload (AddBrushMask): the mask's id (FOrreryTerrainBrushMaskId's value); 0 otherwise.

UploadedBytesBlueprintReadOnlyint640

A brush mask upload accepted so far: the bytes of the upload the server holds, from which the client sends the rest (a resume after a rejoin starts there).

The upload's whole size once the server holds every byte or the mask.

Blueprint