Struct LagCompensationConfig

Singleton entity that allow to configure the NetCode LagCompensation system. If the singleton does not exist the PhysicsWorldHistory system will not run. If you want to use PhysicsWorldHistory in a prediction system the config must exist in both client and server worlds, but in the client world HistorySize can be different from the server - usually 1 is enough on the client.

Implements

IComponentData

IQueryTypeParameter

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.NetCode

Assembly: Unity.NetCode.Physics.dll

Syntax

public struct LagCompensationConfig : IComponentData, IQueryTypeParameter

Fields

ClientHistorySize

The number of physics world states that are backed up on the client. This cannot be more than the maximum capacity (of RawHistoryBufferMaxCapacity), but typically only needs to be around ~4 (to allow the client to check its own shots against the historic entries). Setting the value to 0 will disable recording the physics history on the client. By default, the history size on the client is 1.

Declaration

public int ClientHistorySize

Field Value

Type	Description
int

Remarks

Must be 0 (OFF/DISABLED), otherwise a power of 2 (for the ring-buffer to return correct values when ServerTick wraps uint max value).

DeepCopyDynamicColliders

Determines whether or not netcode's call to Unity.Physics.CollisionWorld.Clone() deep copies dynamic colliders. Set this to true if you want PhysicsWorldHistory to return accurate query information for historic queries against dynamic entities.

Declaration

public bool DeepCopyDynamicColliders

Field Value

Type	Description
bool

Remarks

Also note: From netcode's POV, querying entities which have not been deep copied is considered "undefined behaviour". The only requirement we make here is that the Physics query itself will not throw an exception (as safely handling this flow is a Physics requirement).

DeepCopyStaticColliders

Determines whether or not netcode's call to Unity.Physics.CollisionWorld.Clone() deep copies static colliders. Set this to true if you want PhysicsWorldHistory to return accurate query information for historic queries against static entities. Only needed if (presumably rare) changes to static collider information (including geometry changes) causes invalid collision detection, which should be an exceptional case.

Declaration

public bool DeepCopyStaticColliders

Field Value

Type	Description
bool

Remarks

For large worlds, copying static geometry is best avoided. Instead: Run two queries: One against the current static geometry (using layers), then use that collision hit result to set the max cast distance for the dynamic colliders query.

If your games static geometry occasionally changes (e.g. chopping down a tree), manually copy these bodies colliders via DeepCopyRigidBodyCollidersWhitelist.

Also note: From netcode's POV, querying entities which have not been deep copied is considered "undefined behaviour". The only requirement we make here is that the Physics query itself will not throw an exception (as safely handling this flow is a Physics requirement).

ServerHistorySize

The number of physics world states that are backed up on the server. This cannot be more than the maximum capacity (of RawHistoryBufferMaxCapacity). Leaving the value at zero will give you the default value (16).

Declaration

public int ServerHistorySize

Field Value

Type	Description
int

Remarks

Must be a power of 2 for the ring-buffer to return correct values when ServerTick wraps uint max value.

Implements

Unity.Entities.IComponentData

Unity.Entities.IQueryTypeParameter