Skip to content

Commit f9b87e8

Browse files
committed
Added NetworkedVar disclaimer
1 parent e0cdfc5 commit f9b87e8

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

docs/_data/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
- networkedvar
1616
- scene-management
1717
- object-ownership
18+
- ways-to-syncronize
1819

1920
- title: Core Components
2021
docs:
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Ways To Syncronize
3+
permalink: /wiki/ways-to-syncronize/
4+
---
5+
6+
Syncronization can be done in multiple ways in the MLAPI. Each method has a different optimal usecase and support different features.
7+
8+
### Messaging System
9+
For starters, the messaing system can be used. This provides sending any data. The parameters supported include most primitives and any classes and structures that implement the IBitWritable interface. This allows for custom types to be serialized easily. This way, custom types can be sent in RPC's without extra work. For more information, see the Messaging System wiki.
10+
11+
### INetworkedVar
12+
The second way is to use the NetworkedVar system. This allows data to be synced by the library rather than by the developer. The NetworkedVar system supports syncing of data to new users in the spawn call automatically and delta compression. For more information, see the NetworkedVar wiki.

docs/_docs/the-basics/networkedvar.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ By default, the MLAPI comes with 3 different containers. NetworkedList, Networke
99

1010
Since the NetworkedVar container is a wrapper container around the value, the value has be accessed via the .Value property.
1111

12+
13+
<div class="panel panel-warning">
14+
<div class="panel-heading">
15+
<h3 class="panel-title">Disclaimer</h3>
16+
</div>
17+
<div class="panel-body">
18+
The NetworkedVar, NetworkedList and NetworkedDictionary implementations are <b>primarly</b> designed as samples showing to do create INetworkedVar structures. The NetworkedVar container is however concidered production ready for simple types.
19+
</div>
20+
</div>
21+
1222
To create your own NetworkedVar container, simply create a class with the INetworkedVar interface and declare it as a field of a NetworkedBehaviour. To learn how to write your own containers for more complex structures, see the NetworkedVar implementation. To learn how to do custom delta encoding on complex structures. See the SyncedDictionary and SyncedLIst implementations.
1323

1424

0 commit comments

Comments
 (0)