Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · function

Native::

EncodeNetRecord

Experimental

Append one record in its canonical, unbatched form: U16 kTerrainNetVersion, U8 kind, U64 seq, U32 author, U32 payload size, then the payload.

Declaration

ENetDecode EncodeNetRecord(FNetSeq Seq, ETerrainNetRecordKind Kind, FTerrainAuthor Author,
                                                   const uint8_t* Payload, size_t Size, std::vector<uint8_t>& Out);
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.
Thread
Pure, any thread.

Description

Little-endian, every field written.

Parameters

NameTypeDefaultMeaning
SeqFNetSeq——
KindETerrainNetRecordKind——
AuthorFTerrainAuthor——
Payloadconst uint8_t*——
Sizesize_t——
Outstd::vector<uint8_t>&——

Returns

Ok with the record appended to Out; otherwise CheckNetPayload's refusal, BadSequence for a sequence number of 0 on a sequenced kind, and Out unchanged.

Note.

Pure, any thread.