Class NetCodePhysicsConfig

Component used to enable predicted physics automatic world changing(PredictedPhysicsNonGhostWorld) and lag compensation (EnableLagCompensation) and tweak their settings. At conversion time, a singleton entity is added to the scene/subscene if either one of, or both of the features are enabled, and the PredictedPhysicsNonGhostWorld, EnableLagCompensation components are automatically added to it based on these settings.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
NetCodePhysicsConfig
Inherited Members
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, InstantiateParameters)
Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.Instantiate<T>(T, InstantiateParameters)
Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: Unity.NetCode
Assembly: Unity.NetCode.Physics.Hybrid.dll
Syntax
[DisallowMultipleComponent]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.netcode@latest/index.html?subfolder=/api/Unity.NetCode.NetCodePhysicsConfig.html")]
public sealed class NetCodePhysicsConfig : MonoBehaviour

Fields

ClientHistorySize

Declaration
[Tooltip("The number of physics world states that are backed up on the client. This cannot be more than the maximum capacity (32), and must be a power of two.\n\nThe default value is 1, but setting it to 0 will disable recording the physics history on the client, reducing CPU and memory consumption.")]
public int ClientHistorySize
Field Value
Type Description
int

ClientNonGhostWorldIndex

When using predicted physics all dynamic physics objects in the main physics world on the client must be ghosts. Setting this will move any non-ghost in the default physics world to another world.

Declaration
[Tooltip("The physics world index to use for all dynamic physics objects which are not ghosts.")]
public uint ClientNonGhostWorldIndex
Field Value
Type Description
uint

DeepCopyDynamicColliders

Declaration
[Tooltip("Denotes whether or not Netcode will deep copy dynamic colliders into the Lag Compensation CollisionWorld ring buffer used for Lag Compensation.\n\nRecommendation & Default: True.\n\nEnable this if you get exceptions when querying since-destroyed entities.")]
public bool DeepCopyDynamicColliders
Field Value
Type Description
bool

DeepCopyStaticColliders

Declaration
[Tooltip("Denotes whether or not Netcode will deep copy static colliders into the Lag Compensation CollisionWorld ring buffer used for Lag Compensation.\n\nEnable if you need perfectly accurate lag compensation query results with static colliders, which is typically only necessary if they occasionally change.\n\nRecommendation & Default: False.\n\nInstead: Run two queries - one against static geometry - then another against the dynamic entities in the historic buffer.")]
public bool DeepCopyStaticColliders
Field Value
Type Description
bool

EnableLagCompensation

Set to true to enable the use of the LagCompensation system. Server and Client will start recording the physics world state in the PhysicsWorldHistory buffer, which size can be further configured for by changing the ServerHistorySize and ClientHistorySize properties.

Declaration
[Tooltip("Enable/Disable the LagCompensation system. Server and Client will start recording the physics world state in the PhysicsWorldHistory buffer")]
public bool EnableLagCompensation
Field Value
Type Description
bool

PhysicGroupRunMode

Configure how the PhysicsSystemGroup should update inside the PredictedFixedStepSimulationSystemGroup. By default, this option is set to LagCompensationEnabledOrKinematicGhosts (preserve the original behavior). However, in general, a more correct settings would be to either use LagCompensationEnabledOrAnyPhysicsEntities, or AlwaysRun.

Declaration
[Tooltip("Configure how the PhysicsSystemGroup should update inside the <b>PredictedFixedStepSimulationSystemGroup</b>.\nBy default, this option is set to <b>PhysicGroupRunMode.LagCompensationEnabledOrKinematicGhosts</b> (preserve the original behavior).\nHowever, in general, a more correct settings would be to either use <b>PhysicGroupRunMode.LagCompensationEnabledOrAnyPhysicsEntities</b>, or <b>PhysicGroupRunMode.AlwaysRun</b>.\n\n<b>For the client, in particular, because physics can update only if the prediction loop runs, in order to have this settings be used, <color=yellow>it is necessary to configure the PredictedSimulationSystemGroup to always update (by using the ClientTickRate.PredictionLoopUpdateMode property and set that to PredictionLoopUpdateMode.AlwaysRun</color>).</b>")]
public PhysicGroupRunMode PhysicGroupRunMode
Field Value
Type Description
PhysicGroupRunMode
Remarks

For the client, in particular, because physics can update only if the prediction loop runs, in order to have this settings be used, it is necessary to configure the PredictedSimulationSystemGroup to always update (by using the PredictionLoopUpdateMode property and set that to AlwaysRun).

ServerHistorySize

Declaration
[Tooltip("The number of physics world states that are backed up on the server. This cannot be more than the maximum capacity (32), and must be a power of two.\n\nLeaving it at zero will give you the default value (16).")]
public int ServerHistorySize
Field Value
Type Description
int