LoadableObjectIdEditorUtility

Description

Editor utilities for creating and converting LoadableObjectId values when authoring content.

LoadableObjectId is the low-level reference type used by Loadable<T0> for on-demand object loading. These methods convert between live Object instances and serialized loadable object IDs for content directory builds.

Use this utility to populate a root asset or a LoadableObjectId field from a script. It is also useful when implementing custom Editor UI for ScriptableObjects or MonoBehaviours that contain Loadable<T0> or LoadableObjectId fields.

Additional resources: LoadableObjectId, Loadable<T0>, LoadableSceneIdEditorUtility

using Unity.Loading;
using UnityEditor;
using UnityEngine;

namespace BuildDocExamples
{
    // Example showing how to use LoadableObjectIdEditorUtility to convert between Objects and LoadableObjectIds
    public class LoadableObjectIdEditorUtility_Example
    {
        public void ConvertObjectToLoadableObjectId()
        {
            // Load an asset from the AssetDatabase
            Texture2D iconTexture = AssetDatabase.LoadAssetAtPath<Texture2D>("Assets/Icon.png");

            // Convert the Object to a LoadableObjectId
            LoadableObjectId iconId = LoadableObjectIdEditorUtility.CreateLoadableObjectId(iconTexture);

            // Now iconId can be serialized on a ScriptableObject for content directory builds
        }

        public void ConvertLoadableObjectIdToObject()
        {
            LoadableObjectId iconId = new LoadableObjectId();
            // ... (iconId would typically be loaded from serialized data)

            // Convert the LoadableObjectId back to an Object in the Editor
            Object obj = LoadableObjectIdEditorUtility.LoadableObjectIdToObject(iconId);

            if (obj is Texture2D texture)
            {
                // Use the texture in the Editor
                Debug.Log($"Loaded texture: {texture.name}");
            }
        }
    }
}

Static Methods