Skip to content

Commit 76edc25

Browse files
style
adding API comments
1 parent 1e4f991 commit 76edc25

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -509,10 +509,25 @@ public void DeferDespawn(int tickOffset, bool destroy = true)
509509
public enum OwnershipStatus
510510
{
511511
None = 0,
512+
/// <summary>
513+
/// When set, this instance will be automatically redistributed when a client joins (if not locked or no request is pending) or leaves.
514+
/// </summary>
512515
Distributable = 1 << 0,
516+
/// <summary>
517+
/// When set, a non-owner can obtain ownership immediately (without requesting and as long as it is not locked).
518+
/// </summary>
513519
Transferable = 1 << 1,
520+
/// <summary>
521+
/// When set, a non-owner must request ownership from the owner (will always get locked once ownership is transferred).
522+
/// </summary>
514523
RequestRequired = 1 << 2,
524+
/// <summary>
525+
/// When set, only the current session owner may have ownership over this object.
526+
/// </summary>
515527
SessionOwner = 1 << 3,
528+
/// <summary>
529+
/// Used within the inspector view only. When selected it will set the Distributable, Transferable, and RequestRequired flags or if those flags are already set it will select the SessionOwner flag by itself.
530+
/// </summary>
516531
All = ~0,
517532
}
518533

0 commit comments

Comments
 (0)