Assigns a managed reference Id to an object that is referenced using SerializeReference.
Provides a way to specify a managed reference Id for an object that is referenced from a MonoBehaviour, ScriptableObject or another "host" class that supports SerializeReference.
This applies to a referenced object that is assigned to a field that is decorated with SerializeReference.
After being assigned, the Id persists as a permanent local identifier for the object so long as the object is referenced by the host. It will be retained even when the host object is unloaded and reloaded.
In normal usage it isn't necessary to call this API because, by default, Unity automatically generates a unique and unchanging Id when the object is first serialized.
This method should be called between the time the referenced object is created and the next serialization of the host object that references it. If the object is not referenced when the host object is next serialized then Unity prunes the object and discards its assigned Id. An object is "referenced" if it is directly assigned to at least one field of the host object, or is referenced indirectly via fields on other referenced objects.
The managed reference Id value must be a positive number, e.g. between 0 and Int64.MaxValue.
The managed reference Id cannot be used by another object on the same host. However Ids can be reused between hosts.
See Also: GetManagedReferenceIdForObject, GetManagedReference, SerializeReference, SerializedProperty.managedReferenceId.
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.