Skip to content

Commit 04816fb

Browse files
TwoTenPvPTwoTenPvP
committed
Updated API reference
1 parent d21f557 commit 04816fb

File tree

90 files changed

+3955
-2987
lines changed

Some content is hidden

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

90 files changed

+3955
-2987
lines changed

‎docs/_api/BitReaderDeprecated.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ permalink: /api/bit-reader-deprecated/
44
---
55

66
<div style="line-height: 1;">
7-
<h2 markdown="1">BitReaderDeprecated ``class``</h2>
7+
<h2 markdown="1">BitReaderDeprecated ``class`` <small><span class="label label-warning" title="">Obsolete</span></small></h2>
88
<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>

‎docs/_api/BitWriterDeprecated.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ permalink: /api/bit-writer-deprecated/
44
---
55

66
<div style="line-height: 1;">
7-
<h2 markdown="1">BitWriterDeprecated ``class``</h2>
7+
<h2 markdown="1">BitWriterDeprecated ``class`` <small><span class="label label-warning" title="">Obsolete</span></small></h2>
88
<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>

‎docs/_api/EventType_T_.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: EventType<T>
3-
permalink: /api/event-type_-t_/
2+
title: EventType&lt;T&gt;
3+
permalink: /api/event-type%3C-t%3E/
44
---
55

66
<div style="line-height: 1;">

‎docs/_api/FixedQueue_T_.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: FixedQueue<T>
3-
permalink: /api/fixed-queue_-t_/
2+
title: FixedQueue&lt;T&gt;
3+
permalink: /api/fixed-queue%3C-t%3E/
44
---
55

66
<div style="line-height: 1;">
@@ -24,7 +24,7 @@ permalink: /api/fixed-queue_-t_/
2424
<div>
2525
<h3>Public Constructors</h3>
2626
<div style="line-height: 1; ">
27-
<h4 markdown="1"><b>public [``FixedQueue<T>``](/MLAPI/api/fixed-queue_-t_/)(``int`` maxSize);</b></h4>
27+
<h4 markdown="1"><b>public [``FixedQueue<T>``](/MLAPI/api/fixed-queue%3C-t%3E/)(``int`` maxSize);</b></h4>
2828
<p>Creates a new FixedQueue with a given size</p>
2929
</div>
3030
<h5><b>Parameters</b></h5>

‎docs/_api/NetworkConfig.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,6 @@ permalink: /api/network-config/
3636
<h4 markdown="1"><b>public ``IUDPTransport`` NetworkTransport;</b></h4>
3737
<p>The transport hosts the sever uses</p>
3838
</div>
39-
<div style="line-height: 1;">
40-
<h4 markdown="1"><b>public ``string`` RelayAddress;</b></h4>
41-
<p>Only used if the transport is MLPAI-Relay</p>
42-
</div>
43-
<div style="line-height: 1;">
44-
<h4 markdown="1"><b>public ``ushort`` RelayPort;</b></h4>
45-
<p>Only used if the transport is MLPAI-Relay</p>
46-
</div>
47-
<div style="line-height: 1;">
48-
<h4 markdown="1"><b>public ``bool`` RelayEnabled;</b></h4>
49-
<p>Wheter or not to use the relay</p>
50-
</div>
5139
<div style="line-height: 1;">
5240
<h4 markdown="1"><b>public ``List<Channel>`` Channels;</b></h4>
5341
<p>Channels used by the NetworkedTransport</p>

‎docs/_api/NetworkedAnimator.md

Lines changed: 855 additions & 621 deletions
Large diffs are not rendered by default.

‎docs/_api/NetworkedBehaviour.md

Lines changed: 843 additions & 621 deletions
Large diffs are not rendered by default.

‎docs/_api/NetworkedDictionaryEvent_TKey, TValue_.md renamed to ‎docs/_api/NetworkedDictionaryEvent_TKey,TValue_.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: NetworkedDictionaryEvent<TKey, TValue>
3-
permalink: /api/networked-dictionary-event_-tkey, -tvalue_/
2+
title: NetworkedDictionaryEvent&lt;TKey,TValue&gt;
3+
permalink: /api/networked-dictionary-event%3C-tkey,-tvalue%3E/
44
---
55

66
<div style="line-height: 1;">
7-
<h2 markdown="1">NetworkedDictionaryEvent&lt;TKey, TValue&gt; ``struct``</h2>
7+
<h2 markdown="1">NetworkedDictionaryEvent&lt;TKey,TValue&gt; ``struct``</h2>
88
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.NetworkedVar.Collections</p>
99
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
1010
</div>
@@ -13,7 +13,7 @@ permalink: /api/networked-dictionary-event_-tkey, -tvalue_/
1313
<div>
1414
<h3 markdown="1">Public Fields</h3>
1515
<div style="line-height: 1;">
16-
<h4 markdown="1"><b>public ``NetworkedListEventType<TKey, TValue>`` eventType;</b></h4>
16+
<h4 markdown="1"><b>public ``NetworkedListEventType<TKey,TValue>`` eventType;</b></h4>
1717
<p>Enum representing the operation made to the dictionary.</p>
1818
</div>
1919
<div style="line-height: 1;">

‎docs/_api/NetworkedDictionary_TKey, TValue_.md renamed to ‎docs/_api/NetworkedDictionary_TKey,TValue_.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: NetworkedDictionary<TKey, TValue>
3-
permalink: /api/networked-dictionary_-tkey, -tvalue_/
2+
title: NetworkedDictionary&lt;TKey,TValue&gt;
3+
permalink: /api/networked-dictionary%3C-tkey,-tvalue%3E/
44
---
55

66
<div style="line-height: 1;">
7-
<h2 markdown="1">NetworkedDictionary&lt;TKey, TValue&gt; ``class``</h2>
7+
<h2 markdown="1">NetworkedDictionary&lt;TKey,TValue&gt; ``class``</h2>
88
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.NetworkedVar.Collections</p>
99
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
1010
</div>
@@ -44,11 +44,11 @@ permalink: /api/networked-dictionary_-tkey, -tvalue_/
4444
<div>
4545
<h3>Public Constructors</h3>
4646
<div style="line-height: 1; ">
47-
<h4 markdown="1"><b>public [``NetworkedDictionary<TKey, TValue>``](/MLAPI/api/networked-dictionary_-tkey, -tvalue_/)();</b></h4>
47+
<h4 markdown="1"><b>public [``NetworkedDictionary<TKey,TValue>``](/MLAPI/api/networked-dictionary%3C-tkey,-tvalue%3E/)();</b></h4>
4848
<p>Creates a NetworkedDictionary with the default value and settings</p>
4949
</div>
5050
<div style="line-height: 1; ">
51-
<h4 markdown="1"><b>public [``NetworkedDictionary<TKey, TValue>``](/MLAPI/api/networked-dictionary_-tkey, -tvalue_/)([``NetworkedVarSettings``](/MLAPI/api/networked-var-settings/) settings);</b></h4>
51+
<h4 markdown="1"><b>public [``NetworkedDictionary<TKey,TValue>``](/MLAPI/api/networked-dictionary%3C-tkey,-tvalue%3E/)([``NetworkedVarSettings``](/MLAPI/api/networked-var-settings/) settings);</b></h4>
5252
<p>Creates a NetworkedDictionary with the default value and custom settings</p>
5353
</div>
5454
<h5><b>Parameters</b></h5>
@@ -57,21 +57,21 @@ permalink: /api/networked-dictionary_-tkey, -tvalue_/
5757
<p>The settings to use for the NetworkedDictionary</p>
5858
</div>
5959
<div style="line-height: 1; ">
60-
<h4 markdown="1"><b>public [``NetworkedDictionary<TKey, TValue>``](/MLAPI/api/networked-dictionary_-tkey, -tvalue_/)([``NetworkedVarSettings``](/MLAPI/api/networked-var-settings/) settings, ``IDictionary<TKey, TValue>`` value);</b></h4>
60+
<h4 markdown="1"><b>public [``NetworkedDictionary<TKey,TValue>``](/MLAPI/api/networked-dictionary%3C-tkey,-tvalue%3E/)([``NetworkedVarSettings``](/MLAPI/api/networked-var-settings/) settings, ``IDictionary<TKey,TValue>`` value);</b></h4>
6161
</div>
6262
<h5><b>Parameters</b></h5>
6363
<div>
6464
<p style="font-size: 20px; color: #444;" markdown="1">[``NetworkedVarSettings``](/MLAPI/api/networked-var-settings/) settings</p>
6565
</div>
6666
<div>
67-
<p style="font-size: 20px; color: #444;" markdown="1">``IDictionary<TKey, TValue>`` value</p>
67+
<p style="font-size: 20px; color: #444;" markdown="1">``IDictionary<TKey,TValue>`` value</p>
6868
</div>
6969
<div style="line-height: 1; ">
70-
<h4 markdown="1"><b>public [``NetworkedDictionary<TKey, TValue>``](/MLAPI/api/networked-dictionary_-tkey, -tvalue_/)(``IDictionary<TKey, TValue>`` value);</b></h4>
70+
<h4 markdown="1"><b>public [``NetworkedDictionary<TKey,TValue>``](/MLAPI/api/networked-dictionary%3C-tkey,-tvalue%3E/)(``IDictionary<TKey,TValue>`` value);</b></h4>
7171
</div>
7272
<h5><b>Parameters</b></h5>
7373
<div>
74-
<p style="font-size: 20px; color: #444;" markdown="1">``IDictionary<TKey, TValue>`` value</p>
74+
<p style="font-size: 20px; color: #444;" markdown="1">``IDictionary<TKey,TValue>`` value</p>
7575
</div>
7676
</div>
7777
<br>
@@ -171,10 +171,10 @@ permalink: /api/networked-dictionary_-tkey, -tvalue_/
171171
</div>
172172
<br>
173173
<div style="line-height: 1;">
174-
<h4 markdown="1"><b>public ``void`` Add(``KeyValuePair<TKey, TValue>`` item);</b></h4>
174+
<h4 markdown="1"><b>public ``void`` Add(``KeyValuePair<TKey,TValue>`` item);</b></h4>
175175
<h5><b>Parameters</b></h5>
176176
<div>
177-
<p style="font-size: 20px; color: #444;" markdown="1">``KeyValuePair<TKey, TValue>`` item</p>
177+
<p style="font-size: 20px; color: #444;" markdown="1">``KeyValuePair<TKey,TValue>`` item</p>
178178
</div>
179179
</div>
180180
<br>
@@ -183,10 +183,10 @@ permalink: /api/networked-dictionary_-tkey, -tvalue_/
183183
</div>
184184
<br>
185185
<div style="line-height: 1;">
186-
<h4 markdown="1"><b>public ``bool`` Contains(``KeyValuePair<TKey, TValue>`` item);</b></h4>
186+
<h4 markdown="1"><b>public ``bool`` Contains(``KeyValuePair<TKey,TValue>`` item);</b></h4>
187187
<h5><b>Parameters</b></h5>
188188
<div>
189-
<p style="font-size: 20px; color: #444;" markdown="1">``KeyValuePair<TKey, TValue>`` item</p>
189+
<p style="font-size: 20px; color: #444;" markdown="1">``KeyValuePair<TKey,TValue>`` item</p>
190190
</div>
191191
</div>
192192
<br>
@@ -210,7 +210,7 @@ permalink: /api/networked-dictionary_-tkey, -tvalue_/
210210
</div>
211211
<br>
212212
<div style="line-height: 1;">
213-
<h4 markdown="1"><b>public ``IEnumerator<KeyValuePair<TKey, TValue>>`` GetEnumerator();</b></h4>
213+
<h4 markdown="1"><b>public ``IEnumerator<KeyValuePair<TKey,TValue>>`` GetEnumerator();</b></h4>
214214
</div>
215215
<br>
216216
<div style="line-height: 1;">
@@ -222,10 +222,10 @@ permalink: /api/networked-dictionary_-tkey, -tvalue_/
222222
</div>
223223
<br>
224224
<div style="line-height: 1;">
225-
<h4 markdown="1"><b>public ``bool`` Remove(``KeyValuePair<TKey, TValue>`` item);</b></h4>
225+
<h4 markdown="1"><b>public ``bool`` Remove(``KeyValuePair<TKey,TValue>`` item);</b></h4>
226226
<h5><b>Parameters</b></h5>
227227
<div>
228-
<p style="font-size: 20px; color: #444;" markdown="1">``KeyValuePair<TKey, TValue>`` item</p>
228+
<p style="font-size: 20px; color: #444;" markdown="1">``KeyValuePair<TKey,TValue>`` item</p>
229229
</div>
230230
</div>
231231
<br>

‎docs/_api/NetworkedListEventType_TKey, TValue_.md renamed to ‎docs/_api/NetworkedListEventType_TKey,TValue_.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: NetworkedListEventType<TKey, TValue>
3-
permalink: /api/networked-list-event-type_-tkey, -tvalue_/
2+
title: NetworkedListEventType&lt;TKey,TValue&gt;
3+
permalink: /api/networked-list-event-type%3C-tkey,-tvalue%3E/
44
---
55

66
<div style="line-height: 1;">
7-
<h2 markdown="1">NetworkedListEventType&lt;TKey, TValue&gt; ``enum``</h2>
7+
<h2 markdown="1">NetworkedListEventType&lt;TKey,TValue&gt; ``enum``</h2>
88
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.NetworkedVar.Collections</p>
99
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
1010
</div>

0 commit comments

Comments
 (0)