[ Web Proxy ]
URL:
Viewing: https://docs.unity3d.com/ScriptReference/Object.GetInstanceID.html [Back]  [Original]

Unity - Scripting API: Object.GetInstanceID
Version: Unity 6.5 (6000.5)
    • Supported
    • Legacy
    LanguageEnglish
    • C#
    Removed

    Object.GetInstanceID

    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
    Your name Your email Suggestion* Submit suggestion

    Cancel

    Switch to Manual
    Obsolete Use GetEntityId instead.

    Declaration

    public int GetInstanceID();

    Returns

    int Returns the instance ID of the object.

    Description

    Gets the instance ID of the object.

    The instance ID of an object acts like a handle to the in-memory instance. It is always unique, and never has the value 0. Objects loaded from file will be assigned a positive Instance ID. Newly created objects will have a negative Instance ID, and retain that negative value even if the object is later saved to file. Therefore the sign of the InstanceID value is not a safe indicator for whether or not the object is persistent.

    The ID changes between sessions of the player runtime and Editor. As such, the ID is not reliable for performing actions that could span between sessions, for example, loading an object state from a file.

    Additional resources: EditorUtility.InstanceIDToObject, EditorUtility.IsPersistent.


    Web Proxy Viewer  |  New URL  |  Original Page