SyncListStruct<T0>
class in
UnityEngine.Networking
/
Inherits from:Networking.SyncList_1
Suggest a change
Success!
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.
Close
Submission failed
For 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.
Close
Description
This 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
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.
Inherited members
Variables
| 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. |
Public Functions
| 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. |
Protected Functions
| 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. |
Delegates
| SyncListChanged | A delegate that can be populated to recieve callbacks when the list changes. |