com.unity.netcode.gameobjects@1.0.0

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.0.0] - 2022-06-27

### Changed

- Changed version to 1.0.0. (#2046)

Runtime/NetworkVariable/NetworkVariableBase.cs

@@ -12,16 +12,36 @@ namespace Unity.Netcode
         /// </summary>
         internal const NetworkDelivery Delivery = NetworkDelivery.ReliableFragmentedSequenced;
 
+        /// <summary>
+        /// Maintains a link to the associated NetworkBehaviour
+        /// </summary>
         private protected NetworkBehaviour m_NetworkBehaviour;
 
+        /// <summary>
+        /// Initializes the NetworkVariable
+        /// </summary>
+        /// <param name="networkBehaviour">The NetworkBehaviour the NetworkVariable belongs to</param>
         public void Initialize(NetworkBehaviour networkBehaviour)
         {
             m_NetworkBehaviour = networkBehaviour;
         }
 
+        /// <summary>
+        /// The default read permissions
+        /// </summary>
         public const NetworkVariableReadPermission DefaultReadPerm = NetworkVariableReadPermission.Everyone;
+
+        /// <summary>
+        /// The default write permissions
+        /// </summary>
         public const NetworkVariableWritePermission DefaultWritePerm = NetworkVariableWritePermission.Server;
 
+        /// <summary>
+        /// The default constructor for <see cref="NetworkVariableBase"/> that can be used to create a
+        /// custom NetworkVariable.
+        /// </summary>
+        /// <param name="readPerm">the <see cref="NetworkVariableReadPermission"/> access settings</param>
+        /// <param name="writePerm">the <see cref="NetworkVariableWritePermission"/> access settings</param>
         protected NetworkVariableBase(
             NetworkVariableReadPermission readPerm = DefaultReadPerm,
             NetworkVariableWritePermission writePerm = DefaultWritePerm)
@@ -30,6 +50,10 @@ namespace Unity.Netcode
             WritePerm = writePerm;
         }
 
+        /// <summary>
+        /// The <see cref="m_IsDirty"/> property is used to determine if the
+        /// value of the `NetworkVariable` has changed.
+        /// </summary>
         private protected bool m_IsDirty;
 
         /// <summary>
@@ -43,11 +67,15 @@ namespace Unity.Netcode
         /// </summary>
         public readonly NetworkVariableReadPermission ReadPerm;
 
+        /// <summary>
+        /// The write permission for this var
+        /// </summary>
         public readonly NetworkVariableWritePermission WritePerm;
 
         /// <summary>
         /// Sets whether or not the variable needs to be delta synced
         /// </summary>
+        /// <param name="isDirty">Whether or not the var is dirty</param>
         public virtual void SetDirty(bool isDirty)
         {
             m_IsDirty = isDirty;
@@ -70,6 +98,11 @@ namespace Unity.Netcode
             return m_IsDirty;
         }
 
+        /// <summary>
+        /// Gets if a specific client has permission to read the var or not
+        /// </summary>
+        /// <param name="clientId">The client id</param>
+        /// <returns>Whether or not the client has permission to read</returns>
         public bool CanClientRead(ulong clientId)
         {
             switch (ReadPerm)
@@ -82,6 +115,11 @@ namespace Unity.Netcode
             }
         }
 
+        /// <summary>
+        /// Gets if a specific client has permission to write the var or not
+        /// </summary>
+        /// <param name="clientId">The client id</param>
+        /// <returns>Whether or not the client has permission to write</returns>
         public bool CanClientWrite(ulong clientId)
         {
             switch (WritePerm)
@@ -127,6 +165,9 @@ namespace Unity.Netcode
         /// <param name="keepDirtyDelta">Whether or not the delta should be kept as dirty or consumed</param>
         public abstract void ReadDelta(FastBufferReader reader, bool keepDirtyDelta);
 
+        /// <summary>
+        /// Virtual <see cref="IDisposable"/> implementation
+        /// </summary>
         public virtual void Dispose()
         {
         }