Skip to content

Commit 863af55

Browse files
TwoTenPvPTwoTenPvP
committed
docs: Updated API reference
1 parent c2c1611 commit 863af55

15 files changed

+442
-76
lines changed

‎docs/_api/BitStream.md‎

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,18 @@ permalink: /api/bit-stream/
382382
</div>
383383
</div>
384384
<br>
385+
<div style="line-height: 1;">
386+
<h4 markdown="1"><b>public ``Task`` CopyToAsync(``Stream`` destination, ``CancellationToken`` cancellationToken);</b></h4>
387+
<h5 markdown="1">Inherited from: ``Stream``</h5>
388+
<h5><b>Parameters</b></h5>
389+
<div>
390+
<p style="font-size: 20px; color: #444;" markdown="1">``Stream`` destination</p>
391+
</div>
392+
<div>
393+
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
394+
</div>
395+
</div>
396+
<br>
385397
<div style="line-height: 1;">
386398
<h4 markdown="1"><b>public ``Task`` CopyToAsync(``Stream`` destination, ``int`` bufferSize, ``CancellationToken`` cancellationToken);</b></h4>
387399
<h5 markdown="1">Inherited from: ``Stream``</h5>
@@ -505,6 +517,18 @@ permalink: /api/bit-stream/
505517
</div>
506518
</div>
507519
<br>
520+
<div style="line-height: 1;">
521+
<h4 markdown="1"><b>public ``ValueTask<int>`` ReadAsync(``Memory<byte>`` buffer, ``CancellationToken`` cancellationToken);</b></h4>
522+
<h5 markdown="1">Inherited from: ``Stream``</h5>
523+
<h5><b>Parameters</b></h5>
524+
<div>
525+
<p style="font-size: 20px; color: #444;" markdown="1">``Memory<byte>`` buffer</p>
526+
</div>
527+
<div>
528+
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
529+
</div>
530+
</div>
531+
<br>
508532
<div style="line-height: 1;">
509533
<h4 markdown="1"><b>public ``IAsyncResult`` BeginWrite(``byte[]`` buffer, ``int`` offset, ``int`` count, ``AsyncCallback`` callback, ``object`` state);</b></h4>
510534
<h5 markdown="1">Inherited from: ``Stream``</h5>
@@ -569,44 +593,32 @@ permalink: /api/bit-stream/
569593
</div>
570594
<br>
571595
<div style="line-height: 1;">
572-
<h4 markdown="1"><b>public ``int`` Read(``Span<byte>`` destination);</b></h4>
596+
<h4 markdown="1"><b>public ``ValueTask`` WriteAsync(``ReadOnlyMemory<byte>`` buffer, ``CancellationToken`` cancellationToken);</b></h4>
573597
<h5 markdown="1">Inherited from: ``Stream``</h5>
574598
<h5><b>Parameters</b></h5>
575599
<div>
576-
<p style="font-size: 20px; color: #444;" markdown="1">``Span<byte>`` destination</p>
600+
<p style="font-size: 20px; color: #444;" markdown="1">``ReadOnlyMemory<byte>`` buffer</p>
577601
</div>
578-
</div>
579-
<br>
580-
<div style="line-height: 1;">
581-
<h4 markdown="1"><b>public ``void`` Write(``ReadOnlySpan<byte>`` source);</b></h4>
582-
<h5 markdown="1">Inherited from: ``Stream``</h5>
583-
<h5><b>Parameters</b></h5>
584602
<div>
585-
<p style="font-size: 20px; color: #444;" markdown="1">``ReadOnlySpan<byte>`` source</p>
603+
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
586604
</div>
587605
</div>
588606
<br>
589607
<div style="line-height: 1;">
590-
<h4 markdown="1"><b>public ``ValueTask<int>`` ReadAsync(``Memory<byte>`` destination, ``CancellationToken`` cancellationToken);</b></h4>
608+
<h4 markdown="1"><b>public ``int`` Read(``Span<byte>`` buffer);</b></h4>
591609
<h5 markdown="1">Inherited from: ``Stream``</h5>
592610
<h5><b>Parameters</b></h5>
593611
<div>
594-
<p style="font-size: 20px; color: #444;" markdown="1">``Memory<byte>`` destination</p>
595-
</div>
596-
<div>
597-
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
612+
<p style="font-size: 20px; color: #444;" markdown="1">``Span<byte>`` buffer</p>
598613
</div>
599614
</div>
600615
<br>
601616
<div style="line-height: 1;">
602-
<h4 markdown="1"><b>public ``ValueTask`` WriteAsync(``ReadOnlyMemory<byte>`` source, ``CancellationToken`` cancellationToken);</b></h4>
617+
<h4 markdown="1"><b>public ``void`` Write(``ReadOnlySpan<byte>`` buffer);</b></h4>
603618
<h5 markdown="1">Inherited from: ``Stream``</h5>
604619
<h5><b>Parameters</b></h5>
605620
<div>
606-
<p style="font-size: 20px; color: #444;" markdown="1">``ReadOnlyMemory<byte>`` source</p>
607-
</div>
608-
<div>
609-
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
621+
<p style="font-size: 20px; color: #444;" markdown="1">``ReadOnlySpan<byte>`` buffer</p>
610622
</div>
611623
</div>
612624
<br>

‎docs/_api/CustomMessagingManager.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,16 @@ permalink: /api/custom-messaging-manager/
7272
</div>
7373
</div>
7474
<br>
75+
<div style="line-height: 1;">
76+
<h4 markdown="1"><b>public static ``void`` UnregisterNamedMessageHandler(``string`` name);</b></h4>
77+
<p>Unregisters a named message handler.</p>
78+
<h5><b>Parameters</b></h5>
79+
<div>
80+
<p style="font-size: 20px; color: #444;" markdown="1">``string`` name</p>
81+
<p>The name of the message.</p>
82+
</div>
83+
</div>
84+
<br>
7585
<div style="line-height: 1;">
7686
<h4 markdown="1"><b>public static ``void`` SendNamedMessage(``string`` name, ``ulong`` clientId, ``Stream`` stream, ``string`` channel, [``SecuritySendFlags``](/api/security-send-flags/) security);</b></h4>
7787
<p>Sends a named message</p>

‎docs/_api/InvalidConfigException.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ permalink: /api/invalid-config-exception/
66

77
<div style="line-height: 1;">
88
<h2 markdown="1">InvalidConfigException ``class``</h2>
9-
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Relay.Transports</p>
9+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Transports.UNET</p>
1010
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
1111
</div>
1212
<div>

‎docs/_api/MultiplexTransportAdapter.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ permalink: /api/multiplex-transport-adapter/
2323
<br>
2424
<div>
2525
<h3 markdown="1">Inherited Properties</h3>
26+
<div style="line-height: 1;">
27+
<h4 markdown="1"><b>public ``TransportChannel[]`` MLAPI_CHANNELS { get; }</b></h4>
28+
<h5 markdown="1">Inherited from: [``Transport``](/api/transport/)</h5>
29+
</div>
2630
<div style="line-height: 1;">
2731
<h4 markdown="1"><b>public ``bool`` useGUILayout { get; set; }</b></h4>
2832
<h5 markdown="1">Inherited from: ``MonoBehaviour``</h5>

‎docs/_api/NetworkConfig.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,11 @@ permalink: /api/network-config/
101101
<h4 markdown="1"><b>public ``bool`` EnsureNetworkedVarLengthSafety;</b></h4>
102102
<p>Whether or not to ensure that NetworkedVars can be read even if a client accidentally writes where its not allowed to. This costs some CPU and bandwdith.</p>
103103
</div>
104+
<div style="line-height: 1;">
105+
<h4 markdown="1"><b>public ``bool`` EnableSceneManagement;</b></h4>
106+
<p>Enables scene management. This will allow network scene switches and automatic scene diff corrections upon connect.
107+
SoftSynced scene objects wont work with this disabled. That means that disabling SceneManagement also enables PrefabSync.</p>
108+
</div>
104109
<div style="line-height: 1;">
105110
<h4 markdown="1"><b>public ``bool`` ForceSamePrefabs;</b></h4>
106111
<p>Whether or not the MLAPI should check for differences in the prefabs at connection.

‎docs/_api/NetworkedVarSettings.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ permalink: /api/networked-var-settings/
3232
<div style="line-height: 1;">
3333
<h4 markdown="1"><b>public ``float`` SendTickrate;</b></h4>
3434
<p>The maximum times per second this var will be synced.
35-
Less than or equal to 0 will cause the variable to sync as soon as possible after being changed.</p>
35+
A value of 0 will cause the variable to sync as soon as possible after being changed.
36+
A value of less than 0 will cause the variable to sync only at once at spawn and not update again.</p>
3637
</div>
3738
<div style="line-height: 1;">
3839
<h4 markdown="1"><b>public ``string`` SendChannel;</b></h4>

‎docs/_api/NetworkingManager.md‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -213,22 +213,6 @@ permalink: /api/networking-manager/
213213
<h4 markdown="1"><b>public ``Dictionary<ulong,PendingClient>`` PendingClients;</b></h4>
214214
<p>Gets a dictionary of the clients that have been accepted by the transport but are still pending by the MLAPI.</p>
215215
</div>
216-
<div style="line-height: 1;">
217-
<h4 markdown="1"><b>public ``Action<ulong>`` OnClientConnectedCallback;</b></h4>
218-
<p>The callback to invoke once a client connects</p>
219-
</div>
220-
<div style="line-height: 1;">
221-
<h4 markdown="1"><b>public ``Action<ulong>`` OnClientDisconnectCallback;</b></h4>
222-
<p>The callback to invoke when a client disconnects</p>
223-
</div>
224-
<div style="line-height: 1;">
225-
<h4 markdown="1"><b>public ``Action`` OnServerStarted;</b></h4>
226-
<p>The callback to invoke once the server is ready</p>
227-
</div>
228-
<div style="line-height: 1;">
229-
<h4 markdown="1"><b>public ``Action<byte[],ulong,ConnectionApprovedDelegate>`` ConnectionApprovalCallback;</b></h4>
230-
<p>The callback to invoke during connection approval</p>
231-
</div>
232216
<div style="line-height: 1;">
233217
<h4 markdown="1"><b>public [``NetworkConfig``](/api/network-config/) NetworkConfig;</b></h4>
234218
<p>The current NetworkingConfiguration</p>

‎docs/_api/PooledBitStream.md‎

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,6 @@ permalink: /api/pooled-bit-stream/
8787
</div>
8888
</div>
8989
<br>
90-
<div>
91-
<h3>Public Constructors</h3>
92-
<div style="line-height: 1; ">
93-
<h4 markdown="1"><b>public [``PooledBitStream``](/api/pooled-bit-stream/)();</b></h4>
94-
</div>
95-
</div>
96-
<br>
9790
<div>
9891
<h3 markdown="1">Public Methods</h3>
9992
<div style="line-height: 1;">
@@ -386,6 +379,18 @@ permalink: /api/pooled-bit-stream/
386379
</div>
387380
</div>
388381
<br>
382+
<div style="line-height: 1;">
383+
<h4 markdown="1"><b>public ``Task`` CopyToAsync(``Stream`` destination, ``CancellationToken`` cancellationToken);</b></h4>
384+
<h5 markdown="1">Inherited from: ``Stream``</h5>
385+
<h5><b>Parameters</b></h5>
386+
<div>
387+
<p style="font-size: 20px; color: #444;" markdown="1">``Stream`` destination</p>
388+
</div>
389+
<div>
390+
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
391+
</div>
392+
</div>
393+
<br>
389394
<div style="line-height: 1;">
390395
<h4 markdown="1"><b>public ``Task`` CopyToAsync(``Stream`` destination, ``int`` bufferSize, ``CancellationToken`` cancellationToken);</b></h4>
391396
<h5 markdown="1">Inherited from: ``Stream``</h5>
@@ -509,6 +514,18 @@ permalink: /api/pooled-bit-stream/
509514
</div>
510515
</div>
511516
<br>
517+
<div style="line-height: 1;">
518+
<h4 markdown="1"><b>public ``ValueTask<int>`` ReadAsync(``Memory<byte>`` buffer, ``CancellationToken`` cancellationToken);</b></h4>
519+
<h5 markdown="1">Inherited from: ``Stream``</h5>
520+
<h5><b>Parameters</b></h5>
521+
<div>
522+
<p style="font-size: 20px; color: #444;" markdown="1">``Memory<byte>`` buffer</p>
523+
</div>
524+
<div>
525+
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
526+
</div>
527+
</div>
528+
<br>
512529
<div style="line-height: 1;">
513530
<h4 markdown="1"><b>public ``IAsyncResult`` BeginWrite(``byte[]`` buffer, ``int`` offset, ``int`` count, ``AsyncCallback`` callback, ``object`` state);</b></h4>
514531
<h5 markdown="1">Inherited from: ``Stream``</h5>
@@ -573,44 +590,32 @@ permalink: /api/pooled-bit-stream/
573590
</div>
574591
<br>
575592
<div style="line-height: 1;">
576-
<h4 markdown="1"><b>public ``int`` Read(``Span<byte>`` destination);</b></h4>
593+
<h4 markdown="1"><b>public ``ValueTask`` WriteAsync(``ReadOnlyMemory<byte>`` buffer, ``CancellationToken`` cancellationToken);</b></h4>
577594
<h5 markdown="1">Inherited from: ``Stream``</h5>
578595
<h5><b>Parameters</b></h5>
579596
<div>
580-
<p style="font-size: 20px; color: #444;" markdown="1">``Span<byte>`` destination</p>
597+
<p style="font-size: 20px; color: #444;" markdown="1">``ReadOnlyMemory<byte>`` buffer</p>
581598
</div>
582-
</div>
583-
<br>
584-
<div style="line-height: 1;">
585-
<h4 markdown="1"><b>public ``void`` Write(``ReadOnlySpan<byte>`` source);</b></h4>
586-
<h5 markdown="1">Inherited from: ``Stream``</h5>
587-
<h5><b>Parameters</b></h5>
588599
<div>
589-
<p style="font-size: 20px; color: #444;" markdown="1">``ReadOnlySpan<byte>`` source</p>
600+
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
590601
</div>
591602
</div>
592603
<br>
593604
<div style="line-height: 1;">
594-
<h4 markdown="1"><b>public ``ValueTask<int>`` ReadAsync(``Memory<byte>`` destination, ``CancellationToken`` cancellationToken);</b></h4>
605+
<h4 markdown="1"><b>public ``int`` Read(``Span<byte>`` buffer);</b></h4>
595606
<h5 markdown="1">Inherited from: ``Stream``</h5>
596607
<h5><b>Parameters</b></h5>
597608
<div>
598-
<p style="font-size: 20px; color: #444;" markdown="1">``Memory<byte>`` destination</p>
599-
</div>
600-
<div>
601-
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
609+
<p style="font-size: 20px; color: #444;" markdown="1">``Span<byte>`` buffer</p>
602610
</div>
603611
</div>
604612
<br>
605613
<div style="line-height: 1;">
606-
<h4 markdown="1"><b>public ``ValueTask`` WriteAsync(``ReadOnlyMemory<byte>`` source, ``CancellationToken`` cancellationToken);</b></h4>
614+
<h4 markdown="1"><b>public ``void`` Write(``ReadOnlySpan<byte>`` buffer);</b></h4>
607615
<h5 markdown="1">Inherited from: ``Stream``</h5>
608616
<h5><b>Parameters</b></h5>
609617
<div>
610-
<p style="font-size: 20px; color: #444;" markdown="1">``ReadOnlyMemory<byte>`` source</p>
611-
</div>
612-
<div>
613-
<p style="font-size: 20px; color: #444;" markdown="1">``CancellationToken`` cancellationToken</p>
618+
<p style="font-size: 20px; color: #444;" markdown="1">``ReadOnlySpan<byte>`` buffer</p>
614619
</div>
615620
</div>
616621
<br>

‎docs/_api/RelayTransport.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ permalink: /api/relay-transport/
66

77
<div style="line-height: 1;">
88
<h2 markdown="1">RelayTransport ``class``</h2>
9-
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Relay.Transports</p>
9+
<p style="font-size: 20px;"><b>Namespace:</b> MLAPI.Transports.UNET</p>
1010
<p style="font-size: 20px;"><b>Assembly:</b> MLAPI.dll</p>
1111
</div>
1212
<div>

0 commit comments

Comments
 (0)