Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEngine.Networking
/
Inherits from:Networking.SyncList_1
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseThis class is used for lists of structs that are synchronized from the server to clients.
To use SyncListStruct, derive a new class with your struct as the generic parameter.
no example available in JavaScript
using UnityEngine; using UnityEngine.Networking;
public class MyScript : NetworkBehaviour { public struct POW { public int pow; public float f; }
public class SyncListPOW : SyncListStruct<POW> { }
public SyncListPOW m_pows = new SyncListPOW(); }
Make sure your struct members are non-static public members.
We allow the following types to be used in your struct;
• Basic type (byte, int, float, string, UInt64, etc)
• Built-in Unity math type (Vector3, Quaternion, etc),
• Arrays of basic types
• Other structs containing allowable types
• NetworkIdentity
• NetworkInstanceId
• NetworkHash128
• GameObject with a NetworkIdentity component attached.
Serialization methods will be auto-generated for this new class.
Callback | The delegate type used for SyncListChanged. |
Count | Returns the number of elements in this SyncList<T>. |
IsReadOnly | Reports whether the SyncList<T> is read-only. |
Add | Same as List:Add() but the item is added on clients. |
Clear | Same as List:Clear() but the list is cleared on clients. |
Contains | Determines whether the list contains item item. |
CopyTo | Copies the elements of the SyncList<T> to an Array, starting at a particular Array index. |
Dirty | Marks an item in the list as dirty, so it will be updated on clients. |
GetEnumerator | Returns an enumerator that iterates through the SyncList<T>. |
HandleMsg | Internal function used for remote list operations. |
IndexOf | Determines the index of a specific item in the SyncList<T>. |
InitializeBehaviour | Internal function. |
Insert | Same as List::Insert() but also inserts into list on clients. |
Remove | Same as List:Remove except removes on clients also. |
RemoveAt | Same as List:Remove except it removes the index on clients also. |
DeserializeItem | This method is used when deserializing SyncList items from a stream. |
SerializeItem | This is used to write a value object from a SyncList to a stream. |
SyncListChanged | A delegate that can be populated to recieve callbacks when the list changes. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!