158f26b913
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Additional documentation and release notes are available at [Multiplayer Documentation](https://docs-multiplayer.unity3d.com). ## [1.9.1] - 2024-04-18 ### Added - Added AnticipatedNetworkVariable<T>, which adds support for client anticipation of NetworkVariable values, allowing for more responsive gameplay (#2820) - Added AnticipatedNetworkTransform, which adds support for client anticipation of NetworkTransforms (#2820) - Added NetworkVariableBase.ExceedsDirtinessThreshold to allow network variables to throttle updates by only sending updates when the difference between the current and previous values exceeds a threshold. (This is exposed in NetworkVariable<T> with the callback NetworkVariable<T>.CheckExceedsDirtinessThreshold) (#2820) - Added NetworkVariableUpdateTraits, which add additional throttling support: MinSecondsBetweenUpdates will prevent the NetworkVariable from sending updates more often than the specified time period (even if it exceeds the dirtiness threshold), while MaxSecondsBetweenUpdates will force a dirty NetworkVariable to send an update after the specified time period even if it has not yet exceeded the dirtiness threshold. (#2820) - Added virtual method NetworkVariableBase.OnInitialize() which can be used by NetworkVariable subclasses to add initialization code (#2820) - Added virtual method NetworkVariableBase.Update(), which is called once per frame to support behaviors such as interpolation between an anticipated value and an authoritative one. (#2820) - Added NetworkTime.TickWithPartial, which represents the current tick as a double that includes the fractional/partial tick value. (#2820) - Added NetworkTickSystem.AnticipationTick, which can be helpful with implementation of client anticipation. This value represents the tick the current local client was at at the beginning of the most recent network round trip, which enables it to correlate server update ticks with the client tick that may have triggered them. (#2820) - `NetworkVariable` now includes built-in support for `NativeHashSet`, `NativeHashMap`, `List`, `HashSet`, and `Dictionary` (#2813) - `NetworkVariable` now includes delta compression for collection values (`NativeList`, `NativeArray`, `NativeHashSet`, `NativeHashMap`, `List`, `HashSet`, `Dictionary`, and `FixedString` types) to save bandwidth by only sending the values that changed. (Note: For `NativeList`, `NativeArray`, and `List`, this algorithm works differently than that used in `NetworkList`. This algorithm will use less bandwidth for "set" and "add" operations, but `NetworkList` is more bandwidth-efficient if you are performing frequent "insert" operations.) (#2813) - `UserNetworkVariableSerialization` now has optional callbacks for `WriteDelta` and `ReadDelta`. If both are provided, they will be used for all serialization operations on NetworkVariables of that type except for the first one for each client. If either is missing, the existing `Write` and `Read` will always be used. (#2813) - Network variables wrapping `INetworkSerializable` types can perform delta serialization by setting `UserNetworkVariableSerialization<T>.WriteDelta` and `UserNetworkVariableSerialization<T>.ReadDelta` for those types. The built-in `INetworkSerializable` serializer will continue to be used for all other serialization operations, but if those callbacks are set, it will call into them on all but the initial serialization to perform delta serialization. (This could be useful if you have a large struct where most values do not change regularly and you want to send only the fields that did change.) (#2813) ### Fixed - Fixed issue where NetworkTransformEditor would throw and exception if you excluded the physics package. (#2871) - Fixed issue where `NetworkTransform` could not properly synchronize its base position when using half float precision. (#2845) - Fixed issue where the host was not invoking `OnClientDisconnectCallback` for its own local client when internally shutting down. (#2822) - Fixed issue where NetworkTransform could potentially attempt to "unregister" a named message prior to it being registered. (#2807) - Fixed issue where in-scene placed `NetworkObject`s with complex nested children `NetworkObject`s (more than one child in depth) would not synchronize properly if WorldPositionStays was set to true. (#2796) ### Changed - Changed `NetworkObjectReference` and `NetworkBehaviourReference` to allow null references when constructing and serializing. (#2874) - Changed `NetworkAnimator` no longer requires the `Animator` component to exist on the same `GameObject`. (#2872) - Changed `NetworkTransform` to now use `NetworkTransformMessage` as opposed to named messages for NetworkTransformState updates. (#2810) - Changed `CustomMessageManager` so it no longer attempts to register or "unregister" a null or empty string and will log an error if this condition occurs. (#2807)
89 lines
3.1 KiB
C#
89 lines
3.1 KiB
C#
#if COM_UNITY_MODULES_PHYSICS2D
|
|
using UnityEngine;
|
|
|
|
namespace Unity.Netcode.Components
|
|
{
|
|
/// <summary>
|
|
/// NetworkRigidbody allows for the use of <see cref="Rigidbody2D"/> on network objects. By controlling the kinematic
|
|
/// mode of the rigidbody and disabling it on all peers but the authoritative one.
|
|
/// </summary>
|
|
[RequireComponent(typeof(Rigidbody2D))]
|
|
[RequireComponent(typeof(NetworkTransform))]
|
|
[AddComponentMenu("Netcode/Network Rigidbody 2D")]
|
|
public class NetworkRigidbody2D : NetworkBehaviour
|
|
{
|
|
private Rigidbody2D m_Rigidbody;
|
|
private NetworkTransform m_NetworkTransform;
|
|
|
|
private bool m_OriginalKinematic;
|
|
private RigidbodyInterpolation2D m_OriginalInterpolation;
|
|
|
|
// Used to cache the authority state of this rigidbody during the last frame
|
|
private bool m_IsAuthority;
|
|
|
|
/// <summary>
|
|
/// Gets a bool value indicating whether this <see cref="NetworkRigidbody2D"/> on this peer currently holds authority.
|
|
/// </summary>
|
|
private bool HasAuthority => m_NetworkTransform.CanCommitToTransform;
|
|
|
|
private void Awake()
|
|
{
|
|
m_Rigidbody = GetComponent<Rigidbody2D>();
|
|
m_NetworkTransform = GetComponent<NetworkTransform>();
|
|
|
|
// Turn off physics for the rigid body until spawned, otherwise
|
|
// clients can run fixed update before the first full
|
|
// NetworkTransform update
|
|
m_Rigidbody.isKinematic = true;
|
|
}
|
|
|
|
private void FixedUpdate()
|
|
{
|
|
if (IsSpawned)
|
|
{
|
|
if (HasAuthority != m_IsAuthority)
|
|
{
|
|
m_IsAuthority = HasAuthority;
|
|
UpdateRigidbodyKinematicMode();
|
|
}
|
|
}
|
|
}
|
|
|
|
// Puts the rigidbody in a kinematic non-interpolated mode on everyone but the server.
|
|
private void UpdateRigidbodyKinematicMode()
|
|
{
|
|
if (m_IsAuthority == false)
|
|
{
|
|
m_OriginalKinematic = m_Rigidbody.isKinematic;
|
|
m_Rigidbody.isKinematic = true;
|
|
|
|
m_OriginalInterpolation = m_Rigidbody.interpolation;
|
|
// Set interpolation to none, the NetworkTransform component interpolates the position of the object.
|
|
m_Rigidbody.interpolation = RigidbodyInterpolation2D.None;
|
|
}
|
|
else
|
|
{
|
|
// Resets the rigidbody back to it's non replication only state. Happens on shutdown and when authority is lost
|
|
m_Rigidbody.isKinematic = m_OriginalKinematic;
|
|
m_Rigidbody.interpolation = m_OriginalInterpolation;
|
|
}
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public override void OnNetworkSpawn()
|
|
{
|
|
m_IsAuthority = HasAuthority;
|
|
m_OriginalKinematic = m_Rigidbody.isKinematic;
|
|
m_OriginalInterpolation = m_Rigidbody.interpolation;
|
|
UpdateRigidbodyKinematicMode();
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public override void OnNetworkDespawn()
|
|
{
|
|
UpdateRigidbodyKinematicMode();
|
|
}
|
|
}
|
|
}
|
|
#endif // COM_UNITY_MODULES_PHYSICS2D
|