SyncLists
SyncLists are array based lists similar to C# List that synchronize their contents from the server to the clients.
A SyncList can contain any supported mirror type.
Differences with UNET
UNET also supports SyncLists, but we have redesigned them to make them more efficient and easier to use. Some of the key differences include:
In UNET, SyncLists were synchronized immediately when they changed. If you add 10 elements, that means 10 separate messages. Mirror synchronizes SyncLists with the SyncVars. The 10 elements and other SyncVars are batched together into a single message. Mirror also respects the sync interval when synchronizing lists.
In UNET if you want a list of structs, you have to use
SyncListStruct
, we changed it to justSyncList
In UNET the Callback is a delegate. In Mirror we changed it to an event, so that you can add many subscribers.
In UNET the Callback tells you the operation and index. In Mirror, the callback also receives an item. We made this change so that we could tell what item was removed.
In UNET you must create a class that inherits from SyncList. In Mirror you can just use SyncList directly (starting with version 20.0.0)
Usage
Add a SyncList field to your NetworkBehaviour class.
SyncList must be declared readonly and initialized in the constructor.
You can also detect when a SyncList changes in the client or server. This is useful for refreshing your character when you add equipment or determining when you need to update your database. Subscribe to the Callback event typically during Start
, OnClientStart
, or OnServerStart
for that.
Note that by the time you subscribe, the list will already be populated, so you will not get a call for the initial data, only updates.
Last updated