Skip to content

Commit 7623b13

Browse files
committed
Added XML docs to visibility API
1 parent 370121a commit 7623b13

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

MLAPI/MonoBehaviours/Core/NetworkedObject.cs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,9 @@ internal set
113113

114114
public delegate bool ObserverDelegate(uint clientId);
115115

116+
/// <summary>
117+
/// Delegate invoked when the MLAPI needs to know if the object should be visible to a client, if null it will assume true
118+
/// </summary>
116119
public ObserverDelegate CheckObjectVisibility = null;
117120

118121
/// <summary>
@@ -123,11 +126,21 @@ internal set
123126

124127
internal readonly HashSet<uint> observers = new HashSet<uint>();
125128

129+
/// <summary>
130+
/// Whether or not this object is visible to a specific client
131+
/// </summary>
132+
/// <param name="clientId">The clientId of the client</param>
133+
/// <returns>True if the client knows about the object</returns>
126134
public bool IsNetworkVisibleTo(uint clientId)
127135
{
128136
return observers.Contains(clientId);
129137
}
130138

139+
/// <summary>
140+
/// Shows a previously hidden object to a client
141+
/// </summary>
142+
/// <param name="clientId">The client to show the object to</param>
143+
/// <param name="payload">An optional payload to send as part of the spawn</param>
131144
public void NetworkShow(uint clientId, Stream payload = null)
132145
{
133146
if (!NetworkingManager.Singleton.IsServer)
@@ -179,6 +192,10 @@ public void NetworkShow(uint clientId, Stream payload = null)
179192
}
180193
}
181194

195+
/// <summary>
196+
/// Hides a object from a specific client
197+
/// </summary>
198+
/// <param name="clientId">The client to hide the object for</param>
182199
public void NetworkHide(uint clientId)
183200
{
184201
if (!NetworkingManager.Singleton.IsServer)

0 commit comments

Comments
 (0)