Namespace Unity.NetCode.HostMigration

Classes

HostMigrationData

Host migration class used to access the host migration system, like getting the host migration data blob and deploying migration data to a new world.

Structs

EnableHostMigration

Enable the host migration feature. This will enable the host migration systems and is required for host migration to work.

HostMigrationConfig

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

HostMigrationInProgress

This component will be present for the duration of a host migration. It can be used when certain systems or operations should run or not run according to host migration state.

HostMigrationStats

Statistics for a running host migration system on the host.

IncludeInMigration

Add to any entity to migrate the associated components in the NonGhostMigrationComponents buffer to the new host. A new entity will be created containing the components with thier data but not from the original archetype its upto the user to manually copy these components back to the correct entity using a user defined linkage method

IsMigrated

This tag is added to ghost and non ghost entities on the new server when they have been respawned after a host migration.

NonGhostMigrationComponents

Singleton buffer to declare which components should be migrated on non ghost entities marked for migration with the IncludeInMigration component

SceneEntityMigrationId

Used internally to track scene entities which have non-ghost components which will be migrated during host migrations. These are attached to entities with the IncludeInMigration component placed in a subscene. When a migration occurs the host migration data will be applied to existing scene entities on the new host (no new entity created), and this identifier is used to establish the matches.