Skip to content

Commit 120cdcc

Browse files
fix: OnGainedOwnership and OnLostOwnership XML API updates (#3365)
Correcting the XML API documentation for OnGainedOwnership and OnLostOwnership when using a distributed authority network topology. [MTTB-1086](https://jira.unity3d.com/browse/MTTB-1086) fix: #3345 ## Changelog NA ## Testing and Documentation - No tests have been added. - Includes edits to existing public API documentation. <!-- Uncomment and mark items off with a * if this PR deprecates any API: ### Deprecated API - [ ] An `[Obsolete]` attribute was added along with a `(RemovedAfter yyyy-mm-dd)` entry. - [ ] An [api updater] was added. - [ ] Deprecation of the API is explained in the CHANGELOG. - [ ] The users can understand why this API was removed and what they should use instead. -->
1 parent e3189a2 commit 120cdcc

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

com.unity.netcode.gameobjects/Runtime/Core/NetworkBehaviour.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -826,7 +826,7 @@ internal void InternalOnNetworkDespawn()
826826

827827
/// <summary>
828828
/// In client-server contexts, this method is invoked on both the server and the local client of the owner when <see cref="Netcode.NetworkObject"/> ownership is assigned.
829-
/// In distributed authority contexts, this method is only invoked on the local client that has been assigned ownership of the associated <see cref="Netcode.NetworkObject"/>.
829+
/// In distributed authority contexts, this method is invoked on all clients connected to the session.
830830
/// </summary>
831831
public virtual void OnGainedOwnership() { }
832832

@@ -863,7 +863,7 @@ internal void InternalOnOwnershipChanged(ulong previous, ulong current)
863863
/// <summary>
864864
/// In client-server contexts, this method is invoked on the local client when it loses ownership of the associated <see cref="Netcode.NetworkObject"/>
865865
/// and on the server when any client loses ownership.
866-
/// In distributed authority contexts, this method is only invoked on the local client that has lost ownership of the associated <see cref="Netcode.NetworkObject"/>.
866+
/// In distributed authority contexts, this method is invoked on all clients connected to the session.
867867
/// </summary>
868868
public virtual void OnLostOwnership() { }
869869

0 commit comments

Comments
 (0)