Skip to content

Commit 8c087e5

Browse files
TwoTenPvPTwoTenPvP
committed
Added struct and enums to API reference
1 parent 9fe053a commit 8c087e5

24 files changed

+623
-10
lines changed

‎docs/_api/ChannelType.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: ChannelType
3+
permalink: /api/channel-type/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">ChannelType ``enum``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Transports</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<p>Delivery methods</p>
12+
<div>
13+
<h3 markdown="1">Enum Values</h3>
14+
<div>
15+
<h4 markdown="1"><b>``Unreliable``</b></h4>
16+
<p>Unreliable message</p>
17+
</div>
18+
<div>
19+
<h4 markdown="1"><b>``UnreliableFragmented``</b></h4>
20+
<p>Unreliable with fragmentation support</p>
21+
</div>
22+
<div>
23+
<h4 markdown="1"><b>``UnreliableSequenced``</b></h4>
24+
<p>Unreliable with sequencing</p>
25+
</div>
26+
<div>
27+
<h4 markdown="1"><b>``Reliable``</b></h4>
28+
<p>Reliable message</p>
29+
</div>
30+
<div>
31+
<h4 markdown="1"><b>``ReliableFragmented``</b></h4>
32+
<p>Reliable with fragmentation support</p>
33+
</div>
34+
<div>
35+
<h4 markdown="1"><b>``ReliableSequenced``</b></h4>
36+
<p>Reliable message where messages are guaranteed to be in the right order</p>
37+
</div>
38+
<div>
39+
<h4 markdown="1"><b>``StateUpdate``</b></h4>
40+
<p>A unreliable state update message</p>
41+
</div>
42+
<div>
43+
<h4 markdown="1"><b>``ReliableStateUpdate``</b></h4>
44+
<p>A reliable state update message</p>
45+
</div>
46+
<div>
47+
<h4 markdown="1"><b>``AllCostDelivery``</b></h4>
48+
<p>A reliable message with high priority</p>
49+
</div>
50+
<div>
51+
<h4 markdown="1"><b>``UnreliableFragmentedSequenced``</b></h4>
52+
<p>Unreliable message with fragmentation where older messages are dropped</p>
53+
</div>
54+
<div>
55+
<h4 markdown="1"><b>``ReliableFragmentedSequenced``</b></h4>
56+
<p>A reliable message with guaranteed order with fragmentation support</p>
57+
</div>
58+
</div>

‎docs/_api/DefaultTransport.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: DefaultTransport
3+
permalink: /api/default-transport/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">DefaultTransport ``enum``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Transports</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<p>Supported built in transport</p>
12+
<div>
13+
<h3 markdown="1">Enum Values</h3>
14+
<div>
15+
<h4 markdown="1"><b>``UNET``</b></h4>
16+
<p>Unity's UNET transport</p>
17+
</div>
18+
<div>
19+
<h4 markdown="1"><b>``MLAPI_Relay``</b></h4>
20+
<p>MLAPI.Relay transport (UNET internally)</p>
21+
</div>
22+
<div>
23+
<h4 markdown="1"><b>``Custom``</b></h4>
24+
<p>Custom transport</p>
25+
</div>
26+
</div>

‎docs/_api/EventType_T_.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: EventType<T>
3+
permalink: /api/event-type_-t_/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">EventType<T> ``enum``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.NetworkedVar.Collections</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<p>Enum representing the different operations available for triggering an event.</p>
12+
<div>
13+
<h3 markdown="1">Enum Values</h3>
14+
<div>
15+
<h4 markdown="1"><b>``Add``</b></h4>
16+
<p>Add</p>
17+
</div>
18+
<div>
19+
<h4 markdown="1"><b>``Insert``</b></h4>
20+
<p>Insert</p>
21+
</div>
22+
<div>
23+
<h4 markdown="1"><b>``Remove``</b></h4>
24+
<p>Remove</p>
25+
</div>
26+
<div>
27+
<h4 markdown="1"><b>``RemoveAt``</b></h4>
28+
<p>Remove at</p>
29+
</div>
30+
<div>
31+
<h4 markdown="1"><b>``Value``</b></h4>
32+
<p>Value changed</p>
33+
</div>
34+
<div>
35+
<h4 markdown="1"><b>``Clear``</b></h4>
36+
<p>Clear</p>
37+
</div>
38+
</div>

‎docs/_api/FixedQueue_T_.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ permalink: /api/fixed-queue_-t_/
44
---
55

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

‎docs/_api/HashSize.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: HashSize
3+
permalink: /api/hash-size/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">HashSize ``enum``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Configuration</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<p></p>
12+
<div>
13+
<h3 markdown="1">Enum Values</h3>
14+
<div>
15+
<h4 markdown="1"><b>``VarIntTwoBytes``</b></h4>
16+
<p></p>
17+
</div>
18+
<div>
19+
<h4 markdown="1"><b>``VarIntFourBytes``</b></h4>
20+
<p></p>
21+
</div>
22+
<div>
23+
<h4 markdown="1"><b>``VarIntEightBytes``</b></h4>
24+
<p></p>
25+
</div>
26+
</div>

‎docs/_api/LogLevel.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: LogLevel
3+
permalink: /api/log-level/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">LogLevel ``enum``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Logging</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<p></p>
12+
<div>
13+
<h3 markdown="1">Enum Values</h3>
14+
<div>
15+
<h4 markdown="1"><b>``Developer``</b></h4>
16+
<p></p>
17+
</div>
18+
<div>
19+
<h4 markdown="1"><b>``Normal``</b></h4>
20+
<p></p>
21+
</div>
22+
<div>
23+
<h4 markdown="1"><b>``Error``</b></h4>
24+
<p></p>
25+
</div>
26+
<div>
27+
<h4 markdown="1"><b>``Nothing``</b></h4>
28+
<p></p>
29+
</div>
30+
</div>

‎docs/_api/NetEventType.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: NetEventType
3+
permalink: /api/net-event-type/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">NetEventType ``enum``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Transports</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<p>Represents a netEvent when polling</p>
12+
<div>
13+
<h3 markdown="1">Enum Values</h3>
14+
<div>
15+
<h4 markdown="1"><b>``Data``</b></h4>
16+
<p>New data is received</p>
17+
</div>
18+
<div>
19+
<h4 markdown="1"><b>``Connect``</b></h4>
20+
<p>A client is connected, or client connected to server</p>
21+
</div>
22+
<div>
23+
<h4 markdown="1"><b>``Disconnect``</b></h4>
24+
<p>A client disconnected, or client disconnected from server</p>
25+
</div>
26+
<div>
27+
<h4 markdown="1"><b>``Nothing``</b></h4>
28+
<p>No new event</p>
29+
</div>
30+
</div>

‎docs/_api/NetId.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: NetId
3+
permalink: /api/net-id/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">NetId ``struct``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Transports.UNET</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<p>Represents a ClientId structure</p>
12+
13+
<div>
14+
<h3 markdown="1">Public Fields</h3>
15+
<div style="line-height: 1;">
16+
<h4 markdown="1"><b>public ``byte`` HostId;</b></h4>
17+
<p>The hostId this client is on</p>
18+
</div>
19+
<div style="line-height: 1;">
20+
<h4 markdown="1"><b>public ``ushort`` ConnectionId;</b></h4>
21+
<p>The connectionId this client is assigned</p>
22+
</div>
23+
<div style="line-height: 1;">
24+
<h4 markdown="1"><b>public ``byte`` Meta;</b></h4>
25+
<p>Meta data about hte client</p>
26+
</div>
27+
</div>
28+
<br>
29+
<div>
30+
<h3>Public Constructors</h3>
31+
<div style="line-height: 1; ">
32+
<h4 markdown="1"><b>public [``NetId``](/MLAPI/api/net-id/)(``byte`` hostId, ``ushort`` connectionId, ``bool`` isServer);</b></h4>
33+
<p>Initializes a new instance of the netId struct from transport values</p>
34+
</div>
35+
<h5><b>Parameters</b></h5>
36+
<div>
37+
<p style="font-size: 20px; color: #444;" markdown="1">``byte`` hostId</p>
38+
<p>Host identifier.</p>
39+
</div>
40+
<div>
41+
<p style="font-size: 20px; color: #444;" markdown="1">``ushort`` connectionId</p>
42+
<p>Connection identifier.</p>
43+
</div>
44+
<div>
45+
<p style="font-size: 20px; color: #444;" markdown="1">``bool`` isServer</p>
46+
<p>If set to true is isServer.</p>
47+
</div>
48+
<div style="line-height: 1; ">
49+
<h4 markdown="1"><b>public [``NetId``](/MLAPI/api/net-id/)(``uint`` clientId);</b></h4>
50+
<p>Initializes a new instance of the netId struct from a clientId</p>
51+
</div>
52+
<h5><b>Parameters</b></h5>
53+
<div>
54+
<p style="font-size: 20px; color: #444;" markdown="1">``uint`` clientId</p>
55+
<p>Client identifier.</p>
56+
</div>
57+
</div>
58+
<br>
59+
<div>
60+
<h3 markdown="1">Public Methods</h3>
61+
<div style="line-height: 1;">
62+
<h4 markdown="1"><b>public ``bool`` IsServer();</b></h4>
63+
<p>Returns wheter or not the clientId represents a -1</p>
64+
<h5 markdown="1"><b>Returns ``bool``</b></h5>
65+
<div>
66+
<p>true, if server, false otherwise.</p>
67+
</div>
68+
</div>
69+
<br>
70+
<div style="line-height: 1;">
71+
<h4 markdown="1"><b>public ``uint`` GetClientId();</b></h4>
72+
<p>Gets the clientId.</p>
73+
<h5 markdown="1"><b>Returns ``uint``</b></h5>
74+
<div>
75+
<p>The client identifier.</p>
76+
</div>
77+
</div>
78+
<br>
79+
<div style="line-height: 1;">
80+
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
81+
<p>Checks if two NetId's are equal</p>
82+
<h5><b>Parameters</b></h5>
83+
<div>
84+
<p style="font-size: 20px; color: #444;" markdown="1">``object`` obj</p>
85+
<p>NetId to compare to</p>
86+
</div>
87+
<h5 markdown="1"><b>Returns ``bool``</b></h5>
88+
<div>
89+
<p>Wheter or not the two NetIds are equal</p>
90+
</div>
91+
</div>
92+
<br>
93+
<div style="line-height: 1;">
94+
<h4 markdown="1"><b>public ``int`` GetHashCode();</b></h4>
95+
<p>Returns a hash code for the instance</p>
96+
<h5 markdown="1"><b>Returns ``int``</b></h5>
97+
<div>
98+
<p>Returns a hash code for the instance</p>
99+
</div>
100+
</div>
101+
<br>
102+
</div>
103+
<br>
104+
<div>
105+
<h3 markdown="1">Inherited Methods</h3>
106+
<div style="line-height: 1;">
107+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
108+
<h5 markdown="1">Inherited from: ``ValueType``</h5>
109+
</div>
110+
<br>
111+
<div style="line-height: 1;">
112+
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
113+
<h5 markdown="1">Inherited from: ``object``</h5>
114+
</div>
115+
</div>
116+
<br>

‎docs/_api/NetworkedDictionaryEvent_TKey, TValue_.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: NetworkedDictionaryEvent<TKey, TValue>
3+
permalink: /api/networked-dictionary-event_-t-key, -t-value_/
4+
---
5+
6+
<div style="line-height: 1;">
7+
<h2 markdown="1">NetworkedDictionaryEvent<TKey, TValue> ``struct``</h2>
8+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.NetworkedVar.Collections</p>
9+
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
10+
</div>
11+
<p>Struct containing event information about changes to a NetworkedDictionary.</p>
12+
13+
<div>
14+
<h3 markdown="1">Public Fields</h3>
15+
<div style="line-height: 1;">
16+
<h4 markdown="1"><b>public ``NetworkedListEventType<TKey, TValue>`` eventType;</b></h4>
17+
<p>Enum representing the operation made to the dictionary.</p>
18+
</div>
19+
<div style="line-height: 1;">
20+
<h4 markdown="1"><b>public ``TKey`` key;</b></h4>
21+
<p>the key changed, added or removed if available.</p>
22+
</div>
23+
<div style="line-height: 1;">
24+
<h4 markdown="1"><b>public ``TValue`` value;</b></h4>
25+
<p>The value changed, added or removed if available.</p>
26+
</div>
27+
</div>
28+
<br>
29+
<div>
30+
<h3 markdown="1">Inherited Methods</h3>
31+
<div style="line-height: 1;">
32+
<h4 markdown="1"><b>public ``bool`` Equals(``object`` obj);</b></h4>
33+
<h5 markdown="1">Inherited from: ``ValueType``</h5>
34+
<h5><b>Parameters</b></h5>
35+
<div>
36+
<p style="font-size: 20px; color: #444;" markdown="1">``object`` obj</p>
37+
</div>
38+
</div>
39+
<br>
40+
<div style="line-height: 1;">
41+
<h4 markdown="1"><b>public ``int`` GetHashCode();</b></h4>
42+
<h5 markdown="1">Inherited from: ``ValueType``</h5>
43+
</div>
44+
<br>
45+
<div style="line-height: 1;">
46+
<h4 markdown="1"><b>public ``string`` ToString();</b></h4>
47+
<h5 markdown="1">Inherited from: ``ValueType``</h5>
48+
</div>
49+
<br>
50+
<div style="line-height: 1;">
51+
<h4 markdown="1"><b>public ``Type`` GetType();</b></h4>
52+
<h5 markdown="1">Inherited from: ``object``</h5>
53+
</div>
54+
</div>
55+
<br>

0 commit comments

Comments
 (0)