Struct GhostUpdateSystem

System present only in client worlds, and responsible for:

- updating the state of interpolated ghosts, by copying and intepolating data from the received snapshosts.

- restore the predicted ghost state from the GhostPredictionHistoryState before running the next prediction loop (until new snapshot aren't received).

- updating the PredictedGhost properties for all predicted ghost, by reflecting the latest received snapshot (see AppliedTick) and setting up the correct tick from which the ghost should start predicting (see PredictionStartTick

Implements
ISystem
ISystemCompilerGenerated
Inherited Members
Namespace: Unity.NetCode
Assembly: Unity.NetCode.dll
Syntax
[UpdateInGroup(typeof(GhostSimulationSystemGroup))]
[UpdateAfter(typeof(GhostReceiveSystem))]
[UpdateBefore(typeof(GhostSpawnClassificationSystemGroup))]
[UpdateBefore(typeof(GhostInputSystemGroup))]
[WorldSystemFilter(WorldSystemFilterFlags.ClientSimulation, WorldSystemFilterFlags.Default)]
[BurstCompile]
public struct GhostUpdateSystem : ISystem, ISystemCompilerGenerated

Methods

OnCreate(ref SystemState)

Called when this system is created.

Declaration
public void OnCreate(ref SystemState systemState)
Parameters
Type Name Description
SystemState systemState
Remarks

Implement an OnCreate function to set up system resources when it is created.

OnCreate is invoked before the the first time Unity.Entities.ISystemStartStop.OnStartRunning(ref Unity.Entities.SystemState) and Unity.Entities.ISystem.OnUpdate(ref Unity.Entities.SystemState) are invoked.

OnCreateForCompiler(ref SystemState)

Generated by compilation pipeline and used internally.

Declaration
public void OnCreateForCompiler(ref SystemState state)
Parameters
Type Name Description
SystemState state

The Unity.Entities.SystemState backing this system instance

OnDestroy(ref SystemState)

Called when this system is destroyed.

Declaration
public void OnDestroy(ref SystemState systemState)
Parameters
Type Name Description
SystemState systemState
Remarks

Systems are destroyed when the application shuts down, the World is destroyed, or you call Unity.Entities.World.DestroySystem(Unity.Entities.SystemHandle). In the Unity Editor, system destruction occurs when you exit Play Mode and when scripts are reloaded.

OnUpdate(ref SystemState)

Implement OnUpdate to perform the major work of this system.

Declaration
[BurstCompile]
public void OnUpdate(ref SystemState systemState)
Parameters
Type Name Description
SystemState systemState
Remarks

By default, the system invokes `OnUpdate` once every frame on the main thread. To skip OnUpdate if all of the system's [EntityQueries] are empty, use the [RequireMatchingQueriesForUpdateAttribute]. To limit when OnUpdate is invoked, you can specify components that must exist, or queries that match specific Entities. To do this, call Unity.Entities.SystemState.RequireForUpdate<T>() or Unity.Entities.SystemState.RequireForUpdate(Unity.Entities.EntityQuery) in the system's OnCreate method. For more information, see Unity.Entities.SystemState.ShouldRunSystem().

You can instantiate and schedule an Unity.Entities.IJobChunk instance; you can use the [C# Job System] or you can perform work on the main thread. If you call Unity.Entities.EntityManager methods that perform structural changes on the main thread, be sure to arrange the system order to minimize the performance impact of the resulting [sync points]. 

 [sync points]: xref:concepts-structural-changes
 [C# Job System]: https://docs.unity3d.com/Manual/JobSystem.html
 [EntityQueries]: xref:Unity.Entities.EntityQuery
 [RequireMatchingQueriesForUpdateAttribute]: xref:Unity.Entities.RequireMatchingQueriesForUpdateAttribute

Implements

Unity.Entities.ISystem
Unity.Entities.ISystemCompilerGenerated