Skip to content

Commit 40e85e7

Browse files
committed
docs(xml): Added missing xml comments for obsolete properties
1 parent cea4b00 commit 40e85e7

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

MLAPI/MonoBehaviours/Core/NetworkedObject.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,30 +77,45 @@ internal set
7777
/// </summary>
7878
[SerializeField]
7979
public string PrefabHashGenerator;
80+
/// <summary>
81+
/// Gets if this object is a player object
82+
/// </summary>
8083
[Obsolete("Use IsPlayerObject instead", false)]
8184
public bool isPlayerObject => IsPlayerObject;
8285
/// <summary>
8386
/// Gets if this object is a player object
8487
/// </summary>
8588
public bool IsPlayerObject { get; internal set; }
89+
/// <summary>
90+
/// Gets if the object is the the personal clients player object
91+
/// </summary>
8692
[Obsolete("Use IsLocalPlayer instead", false)]
8793
public bool isLocalPlayer => IsLocalPlayer;
8894
/// <summary>
8995
/// Gets if the object is the the personal clients player object
9096
/// </summary>
9197
public bool IsLocalPlayer => NetworkingManager.Singleton != null && IsPlayerObject && OwnerClientId == NetworkingManager.Singleton.LocalClientId;
98+
/// <summary>
99+
/// Gets if the object is owned by the local player or if the object is the local player object
100+
/// </summary>
92101
[Obsolete("Use IsOwner instead", false)]
93102
public bool isOwner => IsOwner;
94103
/// <summary>
95104
/// Gets if the object is owned by the local player or if the object is the local player object
96105
/// </summary>
97106
public bool IsOwner => NetworkingManager.Singleton != null && OwnerClientId == NetworkingManager.Singleton.LocalClientId;
107+
/// <summary>
108+
/// Gets wheter or not the object is owned by anyone
109+
/// </summary>
98110
[Obsolete("Use IsOwnedByServer instead", false)]
99111
public bool isOwnedByServer => IsOwnedByServer;
100112
/// <summary>
101113
/// Gets wheter or not the object is owned by anyone
102114
/// </summary>
103115
public bool IsOwnedByServer => NetworkingManager.Singleton != null && OwnerClientId == NetworkingManager.Singleton.ServerClientId;
116+
/// <summary>
117+
/// Gets if the object has yet been spawned across the network
118+
/// </summary>
104119
[Obsolete("Use IsSpawned instead", false)]
105120
public bool isSpawned => IsSpawned;
106121
/// <summary>

0 commit comments

Comments
 (0)