Skip to content

Commit 8fde6c5

Browse files
TwoTenPvPTwoTenPvP
committed
Generated API docs
1 parent ce75cf1 commit 8fde6c5

File tree

89 files changed

+80438
-22279
lines changed

Some content is hidden

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

89 files changed

+80438
-22279
lines changed

‎docs/_api/ReflectionMehtod.md renamed to ‎docs/_api/AutoBitWritable.md

Lines changed: 16 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,34 @@
11
---
2-
title: ReflectionMehtod
3-
permalink: /api/reflection-mehtod/
2+
title: AutoBitWritable
3+
permalink: /api/auto-bit-writable/
44
---
55

66
<div style="line-height: 1;">
7-
<h2 markdown="1">ReflectionMehtod ``class``</h2>
8-
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI</p>
7+
<h2 markdown="1">AutoBitWritable ``class``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Serialization</p>
99
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
1010
</div>
11+
<p>AutoBitWritable implements IBitWritable and automatically serializes fields using reflection</p>
12+
1113
<div>
12-
<h3 markdown="1">Public Fields</h3>
13-
<div style="line-height: 1;">
14-
<h4 markdown="1"><b>public ``MethodInfo`` method;</b></h4>
15-
</div>
16-
<div style="line-height: 1;">
17-
<h4 markdown="1"><b>public ``Type[]`` parameterTypes;</b></h4>
18-
</div>
14+
<h3 markdown="1">Public Methods</h3>
1915
<div style="line-height: 1;">
20-
<h4 markdown="1"><b>public ``object[]`` parameterRefs;</b></h4>
21-
</div>
22-
</div>
23-
<br>
24-
<div>
25-
<h3>Public Constructors</h3>
26-
<div style="line-height: 1; ">
27-
<h4 markdown="1"><b>public [``ReflectionMehtod``](/MLAPI/api/reflection-mehtod/)(``MethodInfo`` methodInfo);</b></h4>
28-
</div>
16+
<h4 markdown="1"><b>public ``void`` Write(``Stream`` stream);</b></h4>
17+
<p>Writes the contents of the type instance to the stream</p>
2918
<h5><b>Parameters</b></h5>
3019
<div>
31-
<p style="font-size: 20px; color: #444;" markdown="1">``MethodInfo`` methodInfo</p>
20+
<p style="font-size: 20px; color: #444;" markdown="1">``Stream`` stream</p>
21+
<p>The stream to write to</p>
3222
</div>
33-
</div>
34-
<br>
35-
<div>
36-
<h3 markdown="1">Public Methods</h3>
23+
</div>
24+
<br>
3725
<div style="line-height: 1;">
38-
<h4 markdown="1"><b>public ``void`` Invoke(``object`` instance, ``Stream`` stream);</b></h4>
26+
<h4 markdown="1"><b>public ``void`` Read(``Stream`` stream);</b></h4>
27+
<p>Reads the contents from the stream and applies it to the type instance</p>
3928
<h5><b>Parameters</b></h5>
40-
<div>
41-
<p style="font-size: 20px; color: #444;" markdown="1">``object`` instance</p>
42-
</div>
4329
<div>
4430
<p style="font-size: 20px; color: #444;" markdown="1">``Stream`` stream</p>
31+
<p>The stream to read from</p>
4532
</div>
4633
</div>
4734
<br>

‎docs/_api/ClientRPC.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ permalink: /api/client-rpc/
88
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI</p>
99
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
1010
</div>
11+
<p>Attribute used on methods to me marked as ClientRPC
12+
ClientRPC methods can be requested from the server and will execute on a client
13+
Remember that a host is a server and a client</p>
14+
1115
<div>
1216
<h3 markdown="1">Inherited Properties</h3>
1317
<div style="line-height: 1;">

‎docs/_api/ConnectionApprovedDelegate.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ permalink: /api/connection-approved-delegate/
3939
<div>
4040
<h3 markdown="1">Public Methods</h3>
4141
<div style="line-height: 1;">
42-
<h4 markdown="1"><b>public ``void`` Invoke(``uint`` clientId, ``int`` prefabId, ``bool`` approved, ``Nullable<Vector3>`` position, ``Nullable<Quaternion>`` rotation);</b></h4>
42+
<h4 markdown="1"><b>public ``void`` Invoke(``uint`` clientId, ``Nullable<ulong>`` prefabHash, ``bool`` approved, ``Nullable<Vector3>`` position, ``Nullable<Quaternion>`` rotation);</b></h4>
4343
<h5><b>Parameters</b></h5>
4444
<div>
4545
<p style="font-size: 20px; color: #444;" markdown="1">``uint`` clientId</p>
4646
</div>
4747
<div>
48-
<p style="font-size: 20px; color: #444;" markdown="1">``int`` prefabId</p>
48+
<p style="font-size: 20px; color: #444;" markdown="1">``Nullable<ulong>`` prefabHash</p>
4949
</div>
5050
<div>
5151
<p style="font-size: 20px; color: #444;" markdown="1">``bool`` approved</p>
@@ -59,13 +59,13 @@ permalink: /api/connection-approved-delegate/
5959
</div>
6060
<br>
6161
<div style="line-height: 1;">
62-
<h4 markdown="1"><b>public ``IAsyncResult`` BeginInvoke(``uint`` clientId, ``int`` prefabId, ``bool`` approved, ``Nullable<Vector3>`` position, ``Nullable<Quaternion>`` rotation, ``AsyncCallback`` callback, ``object`` object);</b></h4>
62+
<h4 markdown="1"><b>public ``IAsyncResult`` BeginInvoke(``uint`` clientId, ``Nullable<ulong>`` prefabHash, ``bool`` approved, ``Nullable<Vector3>`` position, ``Nullable<Quaternion>`` rotation, ``AsyncCallback`` callback, ``object`` object);</b></h4>
6363
<h5><b>Parameters</b></h5>
6464
<div>
6565
<p style="font-size: 20px; color: #444;" markdown="1">``uint`` clientId</p>
6666
</div>
6767
<div>
68-
<p style="font-size: 20px; color: #444;" markdown="1">``int`` prefabId</p>
68+
<p style="font-size: 20px; color: #444;" markdown="1">``Nullable<ulong>`` prefabHash</p>
6969
</div>
7070
<div>
7171
<p style="font-size: 20px; color: #444;" markdown="1">``bool`` approved</p>

‎docs/_api/DestroyHandlerDelegate.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
title: DestroyHandlerDelegate
3+
permalink: /api/destroy-handler-delegate/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">DestroyHandlerDelegate ``class``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Components</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<p>The delegate used when destroying networked objects</p>
12+
13+
<div>
14+
<h3 markdown="1">Inherited Properties</h3>
15+
<div style="line-height: 1;">
16+
<h4 markdown="1"><b>public ``MethodInfo`` Method { get; }</b></h4>
17+
<h5 markdown="1">Inherited from: ``Delegate``</h5>
18+
</div>
19+
<div style="line-height: 1;">
20+
<h4 markdown="1"><b>public ``object`` Target { get; }</b></h4>
21+
<h5 markdown="1">Inherited from: ``Delegate``</h5>
22+
</div>
23+
</div>
24+
<br>
25+
<div>
26+
<h3>Public Constructors</h3>
27+
<div style="line-height: 1; ">
28+
<h4 markdown="1"><b>public [``DestroyHandlerDelegate``](/MLAPI/api/destroy-handler-delegate/)(``object`` object, ``IntPtr`` method);</b></h4>
29+
</div>
30+
<h5><b>Parameters</b></h5>
31+
<div>
32+
<p style="font-size: 20px; color: #444;" markdown="1">``object`` object</p>
33+
</div>
34+
<div>
35+
<p style="font-size: 20px; color: #444;" markdown="1">``IntPtr`` method</p>
36+
</div>
37+
</div>
38+
<br>
39+
<div>
40+
<h3 markdown="1">Public Methods</h3>
41+
<div style="line-height: 1;">
42+
<h4 markdown="1"><b>public ``void`` Invoke([``NetworkedObject``](/MLAPI/api/networked-object/) networkedObject);</b></h4>
43+
<h5><b>Parameters</b></h5>
44+
<div>
45+
<p style="font-size: 20px; color: #444;" markdown="1">[``NetworkedObject``](/MLAPI/api/networked-object/) networkedObject</p>
46+
</div>
47+
</div>
48+
<br>
49+
<div style="line-height: 1;">
50+
<h4 markdown="1"><b>public ``IAsyncResult`` BeginInvoke([``NetworkedObject``](/MLAPI/api/networked-object/) networkedObject, ``AsyncCallback`` callback, ``object`` object);</b></h4>
51+
<h5><b>Parameters</b></h5>
52+
<div>
53+
<p style="font-size: 20px; color: #444;" markdown="1">[``NetworkedObject``](/MLAPI/api/networked-object/) networkedObject</p>
54+
</div>
55+
<div>
56+
<p style="font-size: 20px; color: #444;" markdown="1">``AsyncCallback`` callback</p>
57+
</div>
58+
<div>
59+
<p style="font-size: 20px; color: #444;" markdown="1">``object`` object</p>
60+
</div>
61+
</div>
62+
<br>
63+
<div style="line-height: 1;">
64+
<h4 markdown="1"><b>public ``void`` EndInvoke(``IAsyncResult`` result);</b></h4>
65+
<h5><b>Parameters</b></h5>
66+
<div>
67+
<p style="font-size: 20px; color: #444;" markdown="1">``IAsyncResult`` result</p>
68+
</div>
69+
</div>
70+
<br>
71+
</div>
72+
<br>
73+
<div>
74+
<h3 markdown="1">Inherited Methods</h3>
75+
<div style="line-height: 1;">
76+
<h4 markdown="1"><b>public ``void`` GetObjectData(``SerializationInfo`` info, ``StreamingContext`` context);</b></h4>
77+
<h5 markdown="1">Inherited from: ``MulticastDelegate``</h5>
78+
<h5><b>Parameters</b></h5>
79+
<div>
80+
<p style="font-size: 20px; color: #444;" markdown="1">``SerializationInfo`` info</p>
81+
</div>
82+
<div>
83+
<p style="font-size: 20px; color: #444;" markdown="1">``StreamingContext`` context</p>
84+
</div>
85+
</div>
86+
<br>
87+
<div style="line-height: 1;">
88+
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
89+
<h5 markdown="1">Inherited from: ``MulticastDelegate``</h5>
90+
<h5><b>Parameters</b></h5>
91+
<div>
92+
<p style="font-size: 20px; color: #444;" markdown="1">``object`` obj</p>
93+
</div>
94+
</div>
95+
<br>
96+
<div style="line-height: 1;">
97+
<h4 markdown="1"><b>public ``int`` GetHashCode();</b></h4>
98+
<h5 markdown="1">Inherited from: ``MulticastDelegate``</h5>
99+
</div>
100+
<br>
101+
<div style="line-height: 1;">
102+
<h4 markdown="1"><b>public ``Delegate[]`` GetInvocationList();</b></h4>
103+
<h5 markdown="1">Inherited from: ``MulticastDelegate``</h5>
104+
</div>
105+
<br>
106+
<div style="line-height: 1;">
107+
<h4 markdown="1"><b>public ``object`` DynamicInvoke(``object[]`` args);</b></h4>
108+
<h5 markdown="1">Inherited from: ``Delegate``</h5>
109+
<h5><b>Parameters</b></h5>
110+
<div>
111+
<p style="font-size: 20px; color: #444;" markdown="1">``object[]`` args</p>
112+
</div>
113+
</div>
114+
<br>
115+
<div style="line-height: 1;">
116+
<h4 markdown="1"><b>public ``object`` Clone();</b></h4>
117+
<h5 markdown="1">Inherited from: ``Delegate``</h5>
118+
</div>
119+
<br>
120+
<div style="line-height: 1;">
121+
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
122+
<h5 markdown="1">Inherited from: ``object``</h5>
123+
</div>
124+
<br>
125+
<div style="line-height: 1;">
126+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
127+
<h5 markdown="1">Inherited from: ``object``</h5>
128+
</div>
129+
</div>
130+
<br>

‎docs/_api/HashSize.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,21 @@ permalink: /api/hash-size/
88
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Configuration</p>
99
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
1010
</div>
11-
<p></p>
11+
<p>Represents the length of a var int encoded hash
12+
Note that the HashSize does not say anything about the actual final output due to the var int encoding
13+
It just says how many bytes the maximum will be</p>
1214
<div>
1315
<h3 markdown="1">Enum Values</h3>
1416
<div>
1517
<h4 markdown="1"><b>``VarIntTwoBytes``</b></h4>
16-
<p></p>
18+
<p>Two byte hash</p>
1719
</div>
1820
<div>
1921
<h4 markdown="1"><b>``VarIntFourBytes``</b></h4>
20-
<p></p>
22+
<p>Four byte hash</p>
2123
</div>
2224
<div>
2325
<h4 markdown="1"><b>``VarIntEightBytes``</b></h4>
24-
<p></p>
26+
<p>Eight byte hash</p>
2527
</div>
2628
</div>

‎docs/_api/MLAPIConstants.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,6 @@ permalink: /api/mlapiconstants/
3333
<div style="line-height: 1;">
3434
<h4 markdown="1"><b>public ``byte`` MLAPI_ADD_OBJECT;</b></h4>
3535
</div>
36-
<div style="line-height: 1;">
37-
<h4 markdown="1"><b>public ``byte`` MLAPI_CLIENT_DISCONNECT;</b></h4>
38-
</div>
3936
<div style="line-height: 1;">
4037
<h4 markdown="1"><b>public ``byte`` MLAPI_DESTROY_OBJECT;</b></h4>
4138
</div>
@@ -45,12 +42,6 @@ permalink: /api/mlapiconstants/
4542
<div style="line-height: 1;">
4643
<h4 markdown="1"><b>public ``byte`` MLAPI_CLIENT_SWITCH_SCENE_COMPLETED;</b></h4>
4744
</div>
48-
<div style="line-height: 1;">
49-
<h4 markdown="1"><b>public ``byte`` MLAPI_SPAWN_POOL_OBJECT;</b></h4>
50-
</div>
51-
<div style="line-height: 1;">
52-
<h4 markdown="1"><b>public ``byte`` MLAPI_DESTROY_POOL_OBJECT;</b></h4>
53-
</div>
5445
<div style="line-height: 1;">
5546
<h4 markdown="1"><b>public ``byte`` MLAPI_CHANGE_OWNER;</b></h4>
5647
</div>
@@ -69,9 +60,21 @@ permalink: /api/mlapiconstants/
6960
<div style="line-height: 1;">
7061
<h4 markdown="1"><b>public ``byte`` MLAPI_SERVER_RPC;</b></h4>
7162
</div>
63+
<div style="line-height: 1;">
64+
<h4 markdown="1"><b>public ``byte`` MLAPI_SERVER_RPC_REQUEST;</b></h4>
65+
</div>
66+
<div style="line-height: 1;">
67+
<h4 markdown="1"><b>public ``byte`` MLAPI_SERVER_RPC_RESPONSE;</b></h4>
68+
</div>
7269
<div style="line-height: 1;">
7370
<h4 markdown="1"><b>public ``byte`` MLAPI_CLIENT_RPC;</b></h4>
7471
</div>
72+
<div style="line-height: 1;">
73+
<h4 markdown="1"><b>public ``byte`` MLAPI_CLIENT_RPC_REQUEST;</b></h4>
74+
</div>
75+
<div style="line-height: 1;">
76+
<h4 markdown="1"><b>public ``byte`` MLAPI_CLIENT_RPC_RESPONSE;</b></h4>
77+
</div>
7578
<div style="line-height: 1;">
7679
<h4 markdown="1"><b>public ``byte`` MLAPI_CUSTOM_MESSAGE;</b></h4>
7780
</div>

‎docs/_api/NetworkConfig.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,6 @@ permalink: /api/network-config/
108108
<h4 markdown="1"><b>public ``int`` SecondsHistory;</b></h4>
109109
<p>The amount of seconds to keep a lag compensation position history</p>
110110
</div>
111-
<div style="line-height: 1;">
112-
<h4 markdown="1"><b>public ``bool`` HandleObjectSpawning;</b></h4>
113-
<p>Wheter or not to make the library handle object spawning</p>
114-
</div>
115-
<div style="line-height: 1;">
116-
<h4 markdown="1"><b>public ``bool`` EnableSceneSwitching;</b></h4>
117-
<p>Wheter or not to enable scene switching</p>
118-
</div>
119111
<div style="line-height: 1;">
120112
<h4 markdown="1"><b>public ``bool`` EnableTimeResync;</b></h4>
121113
<p>If your logic uses the NetworkedTime, this should probably be turned off. If however it's needed to maximize accuracy, this is recommended to be turned on</p>
@@ -126,12 +118,13 @@ permalink: /api/network-config/
126118
If you dynamically add prefabs at runtime, turn this OFF</p>
127119
</div>
128120
<div style="line-height: 1;">
129-
<h4 markdown="1"><b>public [``HashSize``](/MLAPI/api/hash-size/) RpcHashSize;</b></h4>
130-
<p>Decides how many bytes to use for Rpc messaging. Leave this to 2 bytes unless you are facing hash collisions</p>
121+
<h4 markdown="1"><b>public ``bool`` UsePrefabSync;</b></h4>
122+
<p>If true, all NetworkedObject's need to be prefabs and all scene objects will be replaced on server side which causes all serialization to be lost. Useful for multi project setups
123+
If false, Only non scene objects have to be prefabs. Scene objects will be matched using their PrefabInstanceId which can be precomputed globally for a scene at build time. Useful for single projects</p>
131124
</div>
132125
<div style="line-height: 1;">
133-
<h4 markdown="1"><b>public [``HashSize``](/MLAPI/api/hash-size/) PrefabHashSize;</b></h4>
134-
<p>Decides how many bytes to use for Prefab names. Leave this to 2 bytes unless you are facing hash collisions</p>
126+
<h4 markdown="1"><b>public [``HashSize``](/MLAPI/api/hash-size/) RpcHashSize;</b></h4>
127+
<p>Decides how many bytes to use for Rpc messaging. Leave this to 2 bytes unless you are facing hash collisions</p>
135128
</div>
136129
<div style="line-height: 1;">
137130
<h4 markdown="1"><b>public ``int`` LoadSceneTimeOut;</b></h4>
@@ -171,17 +164,13 @@ permalink: /api/network-config/
171164
</div>
172165
<br>
173166
<div style="line-height: 1;">
174-
<h4 markdown="1"><b>public ``void`` FromBase64(``string`` base64, ``bool`` createDummyObject);</b></h4>
167+
<h4 markdown="1"><b>public ``void`` FromBase64(``string`` base64);</b></h4>
175168
<p>Sets the NetworkConfig data with that from a base64 encoded version</p>
176169
<h5><b>Parameters</b></h5>
177170
<div>
178171
<p style="font-size: 20px; color: #444;" markdown="1">``string`` base64</p>
179172
<p>The base64 encoded version</p>
180173
</div>
181-
<div>
182-
<p style="font-size: 20px; color: #444;" markdown="1">``bool`` createDummyObject</p>
183-
<p>Wheter or not to create dummy objects for NetworkedPrefabs</p>
184-
</div>
185174
</div>
186175
<br>
187176
<div style="line-height: 1;">

0 commit comments

Comments
 (0)