Skip to content

Commit cea4b00

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

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

MLAPI/MonoBehaviours/Core/NetworkedBehaviour.cs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,37 +20,55 @@ namespace MLAPI
2020
/// </summary>
2121
public abstract partial class NetworkedBehaviour : MonoBehaviour
2222
{
23+
/// <summary>
24+
/// Gets if the object is the the personal clients player object
25+
/// </summary>
2326
[Obsolete("Use IsLocalPlayer instead", false)]
2427
public bool isLocalPlayer => IsLocalPlayer;
2528
/// <summary>
2629
/// Gets if the object is the the personal clients player object
2730
/// </summary>
2831
public bool IsLocalPlayer => NetworkedObject.IsLocalPlayer;
32+
/// <summary>
33+
/// Gets if the object is owned by the local player or if the object is the local player object
34+
/// </summary>
2935
[Obsolete("Use IsOwner instead", false)]
3036
public bool isOwner => IsOwner;
3137
/// <summary>
3238
/// Gets if the object is owned by the local player or if the object is the local player object
3339
/// </summary>
3440
public bool IsOwner => NetworkedObject.IsOwner;
41+
/// <summary>
42+
/// Gets if we are executing as server
43+
/// </summary>
3544
[Obsolete("Use IsServer instead", false)]
3645
protected bool isServer => IsServer;
3746
/// <summary>
3847
/// Gets if we are executing as server
3948
/// </summary>
4049
protected bool IsServer => IsRunning && NetworkingManager.Singleton.IsServer;
50+
/// <summary>
51+
/// Gets if we are executing as client
52+
/// </summary>
4153
[Obsolete("Use IsClient instead")]
4254
protected bool isClient => IsClient;
4355
/// <summary>
4456
/// Gets if we are executing as client
4557
/// </summary>
4658
protected bool IsClient => IsRunning && NetworkingManager.Singleton.IsClient;
59+
/// <summary>
60+
/// Gets if we are executing as Host, I.E Server and Client
61+
/// </summary>
4762
[Obsolete("Use IsHost instead", false)]
4863
protected bool isHost => IsHost;
4964
/// <summary>
5065
/// Gets if we are executing as Host, I.E Server and Client
5166
/// </summary>
5267
protected bool IsHost => IsRunning && NetworkingManager.Singleton.IsHost;
5368
private bool IsRunning => NetworkingManager.Singleton != null && NetworkingManager.Singleton.IsListening;
69+
/// <summary>
70+
/// Gets wheter or not the object has a owner
71+
/// </summary>
5472
[Obsolete("Use IsOwnedByServer instead", false)]
5573
public bool isOwnedByServer => IsOwnedByServer;
5674
/// <summary>
@@ -61,6 +79,9 @@ public abstract partial class NetworkedBehaviour : MonoBehaviour
6179
/// Contains the sender of the currently executing RPC. Useful for the convenience RPC methods
6280
/// </summary>
6381
protected uint ExecutingRpcSender { get; private set; }
82+
/// <summary>
83+
/// Gets the NetworkedObject that owns this NetworkedBehaviour instance
84+
/// </summary>
6485
[Obsolete("Use NetworkedObject instead", false)]
6586
public NetworkedObject networkedObject => NetworkedObject;
6687
/// <summary>
@@ -79,6 +100,9 @@ public NetworkedObject NetworkedObject
79100
}
80101

81102
private NetworkedObject _networkedObject = null;
103+
/// <summary>
104+
/// Gets the NetworkId of the NetworkedObject that owns the NetworkedBehaviour instance
105+
/// </summary>
82106
[Obsolete("Use NetworkId instead", false)]
83107
public ulong networkId => NetworkId;
84108
/// <summary>

0 commit comments

Comments
 (0)