Skip to content

Commit 24d8636

Browse files
TwoTenPvPTwoTenPvP
committed
Updated Docs to v1.2.0
1 parent 618544b commit 24d8636

File tree

513 files changed

+2983
-1981
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

513 files changed

+2983
-1981
lines changed

‎MLAPI/Attributes/ClientRpc.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ namespace MLAPI.Attributes
88
[AttributeUsage(AttributeTargets.Method)]
99
public class ClientRpc : Attribute
1010
{
11+
/// <summary>
12+
/// The channelName to send this Rpc
13+
/// </summary>
1114
public string channelName = "MLAPI_INTERNAL";
1215
}
1316
}

‎MLAPI/Attributes/Command.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ namespace MLAPI.Attributes
88
[AttributeUsage(AttributeTargets.Method)]
99
public class Command : Attribute
1010
{
11+
/// <summary>
12+
/// The channelName to send this Command
13+
/// </summary>
1114
public string channelName = "MLAPI_INTERNAL";
1215
}
1316
}

‎MLAPI/Attributes/TargetRpc.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ namespace MLAPI.Attributes
88
[AttributeUsage(AttributeTargets.Method)]
99
public class TargetRpc : Attribute
1010
{
11+
/// <summary>
12+
/// The channelName to send this Target
13+
/// </summary>
1114
public string channelName = "MLAPI_INTERNAL";
1215
}
1316
}

‎MLAPI/Data/AttributeMessageMode.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
namespace MLAPI.Data
22
{
3+
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
34
public enum AttributeMessageMode
45
{
56
Disabled,
67
WovenTwoByte,
78
WovenFourByte,
89
WovenEightByte
910
}
11+
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
1012
}

‎MLAPI/MonoBehaviours/Core/NetworkingManager.cs

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1327,7 +1327,6 @@ public void SendToServer<T>(string messageType, string channelName, T instance)
13271327
/// <param name="messageType">User defined messageType</param>
13281328
/// <param name="channelName">User defined channelName</param>
13291329
/// <param name="data">The binary data to send</param>
1330-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
13311330
public void SendToClient(uint clientId, string messageType, string channelName, byte[] data)
13321331
{
13331332
if (!MessageManager.messageTypes.ContainsKey(messageType))
@@ -1360,7 +1359,6 @@ public void SendToClient(uint clientId, string messageType, string channelName,
13601359
/// <param name="messageType">User defined messageType</param>
13611360
/// <param name="channelName">User defined channelName</param>
13621361
/// <param name="writer">The binary data to send</param>
1363-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
13641362
public void SendToClient(uint clientId, string messageType, string channelName, BitWriter writer)
13651363
{
13661364
if (!MessageManager.messageTypes.ContainsKey(messageType))
@@ -1389,7 +1387,6 @@ public void SendToClient(uint clientId, string messageType, string channelName,
13891387
/// <param name="messageType">User defined messageType</param>
13901388
/// <param name="channelName">User defined channelName</param>
13911389
/// <param name="instance">The instance to send</param>
1392-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
13931390
public void SendToClient<T>(int clientId, string messageType, string channelName, T instance)
13941391
{
13951392
SendToClient(clientId, messageType, channelName, BinarySerializer.Serialize<T>(instance));
@@ -1402,7 +1399,6 @@ public void SendToClient<T>(int clientId, string messageType, string channelName
14021399
/// <param name="messageType">User defined messageType</param>
14031400
/// <param name="channelName">User defined channelName</param>
14041401
/// <param name="data">The binary data to send</param>
1405-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
14061402
public void SendToClients(uint[] clientIds, string messageType, string channelName, byte[] data)
14071403
{
14081404
if (!MessageManager.messageTypes.ContainsKey(messageType))
@@ -1434,7 +1430,6 @@ public void SendToClients(uint[] clientIds, string messageType, string channelNa
14341430
/// <param name="messageType">User defined messageType</param>
14351431
/// <param name="channelName">User defined channelName</param>
14361432
/// <param name="writer">The binary data to send</param>
1437-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
14381433
public void SendToClients(uint[] clientIds, string messageType, string channelName, BitWriter writer)
14391434
{
14401435
if (!MessageManager.messageTypes.ContainsKey(messageType))
@@ -1463,7 +1458,6 @@ public void SendToClients(uint[] clientIds, string messageType, string channelNa
14631458
/// <param name="messageType">User defined messageType</param>
14641459
/// <param name="channelName">User defined channelName</param>
14651460
/// <param name="instance">The instance to send</param>
1466-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
14671461
public void SendToClients<T>(int[] clientIds, string messageType, string channelName, T instance)
14681462
{
14691463
SendToClients(clientIds, messageType, channelName, BinarySerializer.Serialize<T>(instance));
@@ -1476,7 +1470,6 @@ public void SendToClients<T>(int[] clientIds, string messageType, string channel
14761470
/// <param name="messageType">User defined messageType</param>
14771471
/// <param name="channelName">User defined channelName</param>
14781472
/// <param name="data">The binary data to send</param>
1479-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
14801473
public void SendToClients(List<uint> clientIds, string messageType, string channelName, byte[] data)
14811474
{
14821475
if (!MessageManager.messageTypes.ContainsKey(messageType))
@@ -1508,7 +1501,6 @@ public void SendToClients(List<uint> clientIds, string messageType, string chann
15081501
/// <param name="messageType">User defined messageType</param>
15091502
/// <param name="channelName">User defined channelName</param>
15101503
/// <param name="writer">The binary data to send</param>
1511-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
15121504
public void SendToClients(List<uint> clientIds, string messageType, string channelName, BitWriter writer)
15131505
{
15141506
if (!MessageManager.messageTypes.ContainsKey(messageType))
@@ -1537,7 +1529,6 @@ public void SendToClients(List<uint> clientIds, string messageType, string chann
15371529
/// <param name="messageType">User defined messageType</param>
15381530
/// <param name="channelName">User defined channelName</param>
15391531
/// <param name="instance">The instance to send</param>
1540-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
15411532
public void SendToClients<T>(List<int> clientIds, string messageType, string channelName, T instance)
15421533
{
15431534
SendToClients(clientIds, messageType, channelName, BinarySerializer.Serialize<T>(instance));
@@ -1549,7 +1540,6 @@ public void SendToClients<T>(List<int> clientIds, string messageType, string cha
15491540
/// <param name="messageType">User defined messageType</param>
15501541
/// <param name="channelName">User defined channelName</param>
15511542
/// <param name="data">The binary data to send</param>
1552-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
15531543
public void SendToClients(string messageType, string channelName, byte[] data)
15541544
{
15551545
if (!MessageManager.messageTypes.ContainsKey(messageType))
@@ -1580,7 +1570,6 @@ public void SendToClients(string messageType, string channelName, byte[] data)
15801570
/// <param name="messageType">User defined messageType</param>
15811571
/// <param name="channelName">User defined channelName</param>
15821572
/// <param name="writer">The binary data to send</param>
1583-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
15841573
public void SendToClients(string messageType, string channelName, BitWriter writer)
15851574
{
15861575
if (!MessageManager.messageTypes.ContainsKey(messageType))
@@ -1608,12 +1597,16 @@ public void SendToClients(string messageType, string channelName, BitWriter writ
16081597
/// <param name="messageType">User defined messageType</param>
16091598
/// <param name="channelName">User defined channelName</param>
16101599
/// <param name="instance">The instance to send</param>
1611-
/// <param name="respectObservers">If this is true, the message will only be sent to clients observing the sender object</param>
1612-
public void SendToClients<T>(string messageType, string channelName, T instance, bool respectObservers = false)
1600+
public void SendToClients<T>(string messageType, string channelName, T instance)
16131601
{
1614-
SendToClients(messageType, channelName, BinarySerializer.Serialize<T>(instance), respectObservers);
1602+
SendToClients(messageType, channelName, BinarySerializer.Serialize<T>(instance));
16151603
}
16161604

1605+
/// <summary>
1606+
/// Returns the NetworkedObject with a given NetworkId
1607+
/// </summary>
1608+
/// <param name="networkId">The NetworkId</param>
1609+
/// <returns>Returns the NetworkedObject</returns>
16171610
public NetworkedObject GetNetworkedObject(uint networkId)
16181611
{
16191612
return SpawnManager.spawnedObjects[networkId];

‎MLAPI/NetworkingManagerComponents/Core/LogHelper.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33

44
namespace MLAPI.NetworkingManagerComponents.Core
55
{
6+
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
67
public enum LogLevel
78
{
89
Developer,
910
Normal,
1011
Nothing
1112
}
13+
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
1214

1315
internal static class LogHelper
1416
{

0 commit comments

Comments
 (0)