Class BaseCollectionUpdateHelper
The base class to test rapidly adding items to a collection type
Inheritance
BaseCollectionUpdateHelper
Inherited Members
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Assembly: Unity.Netcode.RuntimeTests.dll
Syntax
public class BaseCollectionUpdateHelper : NetworkBehaviour
Fields
VerboseMode
Declaration
public static bool VerboseMode
Field Value
Properties
HelperState
Declaration
public BaseCollectionUpdateHelper.HelperStates HelperState { get; }
Property Value
Methods
AddItem()
Declaration
protected virtual void AddItem()
ChangeOwner()
Declaration
public ulong ChangeOwner()
Returns
Type |
Description |
ulong |
next owner or ulong.MaxValue that means the authority did not invoke this method
|
Clear()
Declaration
Log(string)
Declaration
protected void Log(string msg)
Parameters
Type |
Name |
Description |
string |
msg |
|
OnClear()
Declaration
protected virtual void OnClear()
OnNetworkDespawn()
Gets called when the NetworkObject gets despawned. This method runs both client and server side.
Declaration
public override void OnNetworkDespawn()
Overrides
OnNetworkSpawn()
Gets called when the NetworkObject gets spawned, message handlers are ready to be registered, and the network is set up.
Declaration
public override void OnNetworkSpawn()
Overrides
OnOwnershipChanged(ulong, ulong)
Invoked on all clients. Override this method to be notified of any
ownership changes (even if the instance was neither the previous or
newly assigned current owner).
Declaration
protected override void OnOwnershipChanged(ulong previous, ulong current)
Parameters
Type |
Name |
Description |
ulong |
previous |
the previous owner
|
ulong |
current |
the current owner
|
Overrides
OnValidateAgainst(BaseCollectionUpdateHelper)
Declaration
protected virtual bool OnValidateAgainst(BaseCollectionUpdateHelper otherHelper)
Parameters
Returns
SetState(HelperStates)
Declaration
public void SetState(BaseCollectionUpdateHelper.HelperStates helperState)
Parameters
ValidateAgainst(BaseCollectionUpdateHelper)
Declaration
public bool ValidateAgainst(BaseCollectionUpdateHelper otherHelper)
Parameters
Returns
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:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.