Struct GhostPrefabCreation.Config

Configuration used to create a ghost prefab.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.NetCode

Assembly: Unity.NetCode.dll

Syntax

public struct GhostPrefabCreation.Config

Fields

CollectComponentFunc

Optional, custom deterministic function that retrieve all no-backing and serializable component types for this ghost. By serializable, we means components that either have ghost fields (fields with a GhostFieldAttribute attribute) or a GhostComponentAttribute.

Declaration

public PortableFunctionPointer<GhostPrefabCustomSerializer.CollectComponentDelegate> CollectComponentFunc

Field Value

Type	Description
PortableFunctionPointer<GhostPrefabCustomSerializer.CollectComponentDelegate>

DefaultGhostMode

The default mode for this ghost. This controls what the prefab will be instantiated as when the client spawns it, but the default can be overridden and the mode can be changed at runtime.

Declaration

public GhostMode DefaultGhostMode

Field Value

Type	Description
GhostMode

Importance

Higher importance means the ghost will be sent more frequently if there is not enough bandwidth to send everything.

Declaration

public int Importance

Field Value

Type	Description
int

Name

The name of the ghost. When creating prefabs from code this is used to create a unique ghost type.

Declaration

public FixedString64Bytes Name

Field Value

Type	Description
FixedString64Bytes

OptimizationMode

Dynamic optimization mode uses multiple baselines to make sure data is always small. Static optimization mode will compress slightly less when there are changes, but it will have zero cost when there are no changes.

Declaration

public GhostOptimizationMode OptimizationMode

Field Value

Type	Description
GhostOptimizationMode

PredictedSpawnedGhostRollbackToSpawnTick

Enable predicted spawned ghost to rollback their initial spawn state and re-predict until the authoritative spawn has been received from the server.

Declaration

public bool PredictedSpawnedGhostRollbackToSpawnTick

Field Value

Type	Description
bool

RollbackPredictionOnStructuralChanges

Client CPU optimization. Force predicted ghost to always try to continue from the last prediction in case of structural changes. True by default (because may introduce some issue when replicated component are removed).

Declaration

public bool RollbackPredictionOnStructuralChanges

Field Value

Type	Description
bool

SupportedGhostModes

The ghost modes this prefab can be instantiated as. If for example set the Interpolated it is not possible to use this prefab for prediction.

Declaration

public GhostModeMask SupportedGhostModes

Field Value

Type	Description
GhostModeMask

UUID5GhostType

Optional UUID5 identifier used to unique determine the ghost type. By default that ghost type of the generated prefab is calculated using the SHA1 hash of the mandatory Name property (combined with some unique GUID prefix). If user provide a non-default ghost unique UUID5 guid the ghost will use that instead.

Declaration

public Hash128 UUID5GhostType

Field Value

Type	Description
Hash128

UsePreSerialization

Enable pre-serialization for this ghost. Pre-serialization makes it possible to share part of the serialization cpu cost between connections, but it also has that cost when the ghost is not sent.

Declaration

public bool UsePreSerialization

Field Value

Type	Description
bool