diff --git a/com.unity.netcode.gameobjects/Runtime/Components/AnticipatedNetworkTransform.cs b/com.unity.netcode.gameobjects/Runtime/Components/AnticipatedNetworkTransform.cs index d99bd4dc2f..913447beb1 100644 --- a/com.unity.netcode.gameobjects/Runtime/Components/AnticipatedNetworkTransform.cs +++ b/com.unity.netcode.gameobjects/Runtime/Components/AnticipatedNetworkTransform.cs @@ -50,10 +50,24 @@ public class AnticipatedNetworkTransform : NetworkTransform internal override bool HideInterpolateValue => true; #endif + /// + /// Represents a complete transform state for network synchronization and anticipation + /// public struct TransformState { + /// + /// The position component of the transform state in world space coordinates. + /// public Vector3 Position; + + /// + /// The rotation component of the transform state as a quaternion. + /// public Quaternion Rotation; + + /// + /// The scale component of the transform state in local space. + /// public Vector3 Scale; } diff --git a/com.unity.netcode.gameobjects/Runtime/Messaging/RpcTargets/BaseRpcTarget.cs b/com.unity.netcode.gameobjects/Runtime/Messaging/RpcTargets/BaseRpcTarget.cs index 9d81bdecf9..66c88b3eec 100644 --- a/com.unity.netcode.gameobjects/Runtime/Messaging/RpcTargets/BaseRpcTarget.cs +++ b/com.unity.netcode.gameobjects/Runtime/Messaging/RpcTargets/BaseRpcTarget.cs @@ -29,9 +29,9 @@ internal BaseRpcTarget(NetworkManager manager) } /// - /// Can be used to provide additional lock checks before disposing the target. + /// Verifies the target can be disposed based on its lock state. /// - /// The exception thrown if the target is still locked when disposed. + /// Thrown when attempting to dispose a locked temporary RPC target protected void CheckLockBeforeDispose() { if (m_Locked) @@ -41,7 +41,7 @@ protected void CheckLockBeforeDispose() } /// - /// Invoked when the target is disposed. + /// Releases resources used by the RPC target. /// public abstract void Dispose(); diff --git a/com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs b/com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs index 53b7f4f8fb..72258c77f5 100644 --- a/com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs +++ b/com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs @@ -21,12 +21,12 @@ public class NetworkList : NetworkVariableBase where T : unmanaged, IEquatabl public delegate void OnListChangedDelegate(NetworkListEvent changeEvent); /// - /// The callback to be invoked when the list gets changed + /// Creates A NetworkList/> /// public event OnListChangedDelegate OnListChanged; /// - /// Constructor method for + /// Constructor method for /// public NetworkList() { } @@ -132,7 +132,7 @@ public override void WriteDelta(FastBufferWriter writer) } } - /// + /// public override void WriteField(FastBufferWriter writer) { writer.WriteValueSafe((ushort)m_List.Length); @@ -158,12 +158,12 @@ public override void ReadField(FastBufferReader reader) /// public override void ReadDelta(FastBufferReader reader, bool keepDirtyDelta) { - /// This is only invoked by and the only time - /// keepDirtyDelta is set is when it is the server processing. To be able to handle previous - /// versions, we use IsServer to keep the dirty states received and the keepDirtyDelta to - /// actually mark this as dirty and add it to the list of s to - /// be updated. With the forwarding of deltas being handled by , - /// once all clients have been forwarded the dirty events, we clear them by invoking . + // This is only invoked by and the only time + // keepDirtyDelta is set is when it is the server processing. To be able to handle previous + // versions, we use IsServer to keep the dirty states received and the keepDirtyDelta to + // actually mark this as dirty and add it to the list of s to + // be updated. With the forwarding of deltas being handled by , + // once all clients have been forwarded the dirty events, we clear them by invoking . var isServer = m_NetworkManager.IsServer; reader.ReadValueSafe(out ushort deltaCount); for (int i = 0; i < deltaCount; i++) @@ -406,13 +406,22 @@ internal override void PostDeltaRead() } } - /// + /// + /// Returns an enumerator that iterates through the . + /// + /// An enumerator for the . public IEnumerator GetEnumerator() { return m_List.GetEnumerator(); } - /// + /// + /// Adds an item to the end of the . + /// + /// The item to be added to the list. + /// + /// This method checks for write permissions before adding the item. + /// public void Add(T item) { // check write permissions @@ -434,7 +443,12 @@ public void Add(T item) HandleAddListEvent(listEvent); } - /// + /// + /// Removes all items from the . + /// + /// + /// This method checks for write permissions before clearing the list. + /// public void Clear() { // check write permissions @@ -454,14 +468,25 @@ public void Clear() HandleAddListEvent(listEvent); } - /// + /// + /// Determines whether the contains a specific value. + /// + /// The object to locate in the . + /// if the is found in the ; otherwise, . public bool Contains(T item) { int index = m_List.IndexOf(item); return index != -1; } - /// + /// + /// Removes the first occurrence of a specific object from the NetworkList. + /// + /// + /// This method checks for write permissions before removing the item. + /// + /// The object to remove from the list. + /// if the item was successfully removed from the list; otherwise, . public bool Remove(T item) { // check write permissions @@ -488,16 +513,29 @@ public bool Remove(T item) return true; } - /// + /// + /// Gets the number of elements contained in the . + /// public int Count => m_List.Length; - /// + /// + /// Determines the index of a specific in the . + /// + /// The object to remove from the list. + /// The index of the if found in the list; otherwise, -1. public int IndexOf(T item) { return m_List.IndexOf(item); } - /// + /// + /// Inserts to the at the specified . + /// + /// + /// This method checks for write permissions before inserting the item. + /// + /// The index at which the item should be inserted. + /// The item to insert. public void Insert(int index, T item) { // check write permissions @@ -527,7 +565,13 @@ public void Insert(int index, T item) HandleAddListEvent(listEvent); } - /// + /// + /// Removes the item at the specified . + /// + /// + /// This method checks for write permissions before removing the item. + /// + /// The index of the element to remove. public void RemoveAt(int index) { // check write permissions @@ -549,9 +593,14 @@ public void RemoveAt(int index) HandleAddListEvent(listEvent); } - - - /// + /// + /// Gets or sets the element at the specified index in the . + /// + /// + /// This method checks for write permissions before setting the value. + /// + /// The zero-based index of the element to get or set. + /// The element at the specified index. public T this[int index] { get => m_List[index]; @@ -587,7 +636,7 @@ private void HandleAddListEvent(NetworkListEvent listEvent) } /// - /// This is actually unused left-over from a previous interface + /// This method should not be used. It is left over from a previous interface /// public int LastModifiedTick {