Struct HostMigrationConfig

Configuration that can be tune the behaviour of certain internal systems within the host migration feature.

Implements

IComponentData

IQueryTypeParameter

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.NetCode.HostMigration

Assembly: Unity.NetCode.dll

Syntax

public struct HostMigrationConfig : IComponentData, IQueryTypeParameter

Fields

Default

Returns the default config options for host migration.

Declaration

public static HostMigrationConfig Default

Field Value

Type	Description
HostMigrationConfig

MigrationTimeout

The time given for the data of the host migration to be deployed. Is mostly the time needed to wait for subscenes to load and the full list of ghost prefabs to be loaded.

Declaration

public float MigrationTimeout

Field Value

Type	Description
float

ServerUpdateInterval

The amount of time to elapse between gathering all the host migration data to be sent to the service.

Declaration

public float ServerUpdateInterval

Field Value

Type	Description
float

StoreOwnGhosts

Store ghosts owned by the local client on the host. As during a host migration the original host including the client are gone it might be ok to not include the ghosts owned by the now gone client.

Declaration

public bool StoreOwnGhosts

Field Value

Type	Description
bool

Implements

IComponentData

IQueryTypeParameter