Skip to main content

Settings Reference

Project Settings → Plugins → Host Migration. Stored in Config/DefaultGame.ini:

[/Script/HostMigrationCore.HostMigrationSettings]
AdapterClass=/Script/HostMigrationCoreSteam.HostMigrationAdapter_Steam
ClientWaitMap=/Game/Maps/WaitMap.WaitMap

General​

SettingDefaultDescription
bEnabledtrueTurns host migration on or off.
AdapterClassNullThe online backend.

Snapshot​

SettingDefaultDescription
SnapshotInterval3 sHow often the host sends a snapshot. Unchanged snapshots are skipped. Min 0.5.
bUseDeltaSnapshotstrueSend only what changed.
ChunkSize16384Compressed bytes per reliable RPC (1024–60000).
MaxSnapshotBytes524288Compressed snapshots larger than this are dropped with a warning.

Election​

SettingDefaultDescription
CandidateTimeout12 sHow long to wait for a candidate to announce itself before trying the next one.
RejoinTimeout20 sHow long to try to rejoin a host that is still in the session. 0 disables.
bMigrateWhenHostUnreachablefalseIf the host is still in the session but cannot be reached: false = give up, true = migrate anyway.
MaxReconnectAttempts3Connection attempts to a new host before moving to the next candidate.
ReconnectRetryDelay2 sPause between connection attempts.

Restore​

SettingDefaultDescription
ReconnectGracePeriod30 sHow long the new host waits for previous players.
InactivePlayerTimeout300 sHow long a player who left keeps their state for a rejoin. 0 disables.
LeavingPlayerPawnKeepInWorldDestroy, KeepInWorld or RespawnOnRejoin. See Players who come back.
bDestroyPawnWhenInactiveExpirestrueDestroy the unpossessed pawn when a record expires.
ListenOptionslistenURL options the successor opens the map with.
ClientWaitMapnoneMap clients wait in. Strongly recommended.

Presentation​

SettingDefaultDescription
bPauseDuringGracePeriodtruePause on the new host while players reconnect.
bShowMigrationOverlaytrueShow a "reconnecting" overlay during a migration.
OverlayWidgetClassnoneYour own overlay widget. Empty = built-in.
OverlayZOrder1000Z-order of the overlay.
FailedOverlaySeconds4 sHow long "could not continue" shows after a failed migration.

Null adapter​

Set on the adapter class (or a Blueprint subclass of it):

SettingDefaultDescription
ListenPort7777Port the successor listens on.
AssumedHostDelay4 sTime the successor gets to load the map before clients connect.

Console variables​

VariableDescription
HostMigration.Debug.DropEveryNthDelta NClient: drop every Nth delta to test resyncs. 0 = off.