Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · function

Native::

StartJoinReplica

Experimental

LoadJoin, then a replica that expects S + 1 with the head's digest, which continues the head's open strokes (FTerrainReplica::ResumeStrokes).

Declaration

std::unique_ptr<FTerrainReplica> StartJoinReplica(FTerrainWorld& World, const FJoinStreamReader& Reader,
                                                                          EJoinLoad* OutResult = nullptr);
Header
#include "Native/Net/NetJoin.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
Game thread.

Description

Null unless Loaded.

The replica applies records under the head's limits (FJoinHead::Limits), the authority's, never the joiner's own: a record the authority accepted is never refused, or replayed with another keep-out margin, on a replica.

Parameters

NameTypeDefaultMeaning
WorldFTerrainWorld&—

The joiner's world, as LoadJoin takes it.

Readerconst FJoinStreamReader&—

The joiner's stream reader, as LoadJoin takes it.

OutResultEJoinLoad*nullptr

Optional: LoadJoin's result.

Note.

Game thread.