charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 02:50:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document correct dictionary initialization

Browse Source
This commit is contained in:
Paul Pacheco 2019-08-19 16:52:41 -05:00 committed by GitHub
parent 750f17e95f
commit 8aadd245fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/Classes/SyncDictionary.md
View File

@ -14,8 +14,18 @@ A SyncDictionary is an associative array containing an unordered list of key, va
SyncDictionary works much like [SyncLists](SyncLists): when you make a change on the server the change is propagated to all clients and the Callback is called.
<aside class="notice">
Note that by the time you subscribe to the callback, the dictionary will already be initialized, so you will not get a call for the initial data, only updates.
</aside>
To use it, create a class that derives from SyncDictionary for your specific type. This is necessary because the Weaver will add methods to that class. Then add a field to your NetworkBehaviour class.
<aside class="notice">
Note SyncDictionaries must be initialized in the constructor, not in Startxxx(). You can make them readonly to ensure correct usage.
</aside>
## Simple Example
```cs
@ -33,7 +43,7 @@ public class ExamplePlayer : NetworkBehaviour
public int durability;
}
public SyncDictionaryStringItem Equipment = new SyncDictionaryStringItem();
public readonly SyncDictionaryStringItem Equipment = new SyncDictionaryStringItem();
public void OnStartServer()
{
@ -68,6 +78,7 @@ public class ExamplePlayer : NetworkBehaviour
public SyncDictionaryStringItem() : base (new SortedList<string,Item>()) {}
}
public SyncDictionaryStringItem Equipment = new SyncDictionaryStringItem();
public readonly SyncDictionaryStringItem Equipment = new SyncDictionaryStringItem();
}
```