Runtime Editor for Unity

Welcome to the Runtime Editor v.4.0.6 documentation. This toolset includes scripts and prefabs designed to help you create scene editors, game level editors, or your own modeling applications.
If you're new to this documentation, please start with the introduction section for an overview of the Runtime Editor and its features.

Asset Store

Note
Documentation for the previous versions can be found here.

Contents

Introduction

The Runtime Editor consists of several major parts, effectively decoupled using MVVM and dependency injection mechanisms:

Getting Started

  1. Create a new scene.
  2. Click Tools -> Runtime Editor -> Create RTEditor.
    Create RuntimeEditor
  3. Optionally, click Tools -> Runtime Editor -> Create RTExtensions.
  4. Click "Yes" when prompted to add the Game View Camera script.
    Create Game View Camera Script
  5. Create several Game Objects and add the Expose To Editor component.
    Add Expose To Editor
  6. Move these game objects to the Scene game object children.
    Scene Children
  7. Press "Play".
    Getting Started Result

Example Scenes

There are various example scenes available. To access them:

  1. Unpack "Assets/Battlehub/2 RTEditor Demo.unitypackage".
    Unpack 2 RTEditor Demo
  2. Click Tools -> Runtime Editor -> Show me examples.
    Show Me Examples

Note
If you are using Universal or HDRP, when you open the demo scene, also follow the steps in Universal Render Pipeline Support or HDRP Support.

Compatibility Modes

In Runtime Editor 4.x.x, the Runtime Asset Database has replaced the Runtime Save Load subsystem, which is now considered legacy. By default, Runtime Editor cannot open projects created using RTSL. However, there are two compatibility modes, AssetDatabaseOverRTSL and LegacyRTSL,
which allow you to open and work with projects created before RTE 4.x.x.
To select a compatibility mode, use the Compatibility Mode dropdown in the Runtime Editor component editor.
Compatibility Mode

None

In this mode, users will not be able to open legacy RTSL projects. The Project window is replaced with the AssetDatabase window, the Save Scene Dialog and Save Asset Dialog are replaced with the AssetDatabaseSave dialog, and the Select Object Dialog is replaced with the AssetDatabaseSelect dialog. Additional compatibility prefabs like RTSLDeps and AssetDatabaseOverRTSL, along with corresponding compatibility scripts, are not created.

AssetDatabaseOverRTSL

In this mode, users can open both new Asset Database projects and legacy RTSL projects. The Project window is replaced with the AssetDatabase window, the Save Scene Dialog and Save Asset Dialog are replaced with the AssetDatabaseSave dialog, and the Select Object Dialog is replaced with the AssetDatabaseSelect dialog. Old IProjectAsync APIs are available, but corresponding functions must be called using the IRuntimeEditor or IAssetDatabaseModel interface, which is implemented by the AssetDatabaseOverRTSL class.

LegacyRTSL

In this mode, users can open only legacy RTSL projects. All legacy windows and APIs, such as IProjectAsync, are available. While it is possible to use some new methods of the IRuntimeEditor interface and IAssetDatabase interface, some of them might throw exceptions. This mode is not recommended.

RTSL to AssetDatabase Project Converter

An example of a project converter from the old RTSL format to the new AssetDatabase format can be found in Assets\Battlehub\RTEditorDemo\Examples\RTSL to AssetDatabase Project Converter.unity.

The converter is implemented in the RTSLProjectConverter class. It takes the RTSL project path and the new AssetDatabase project path as inputs. The converter performs the following steps:

  1. Copies the folder structure.
  2. Converts assets like materials, meshes, etc.
  3. Converts prefabs.
  4. Converts scenes.

Universal Render Pipeline Support

  1. Unpack "Assets/Battlehub/1 UniversalRP Support.unitypackage".
    Unpack 1 Universal RP
  2. Click "Install/Upgrade" dependencies to install the required Universal Render Pipeline package.
  3. Click Tools -> Runtime Editor -> Use URP RenderPipelineAsset.
  4. Click Tools -> Runtime Editor -> Add URP support for RTEditor.
  5. If you are using Runtime Editor Extensions (RTExtensions prefab), click Tools -> Runtime Editor -> Add URP support for RTEditor again.
    Add Required Prefabs
  6. In Project Settings / Player, switch the color space to Linear.
    Linear Color Space
  7. Update Asset Database using Tools -> Runtime Asset Database -> Build All
    Build All Menu

Note
If the scene window will always be docked, set RenderPipelineInfo.UserForegroundLayerForUI = false. See the MinimalLayoutExample script in Scene1 and Scene2 for details.

HDRP Support

The procedure is the same as for URP Support, except you need to unpack Assets/Battlehub/6 HDRP Support.unitypackage and use the corresponding HDRP menu items.

Common Infrastructure

Overview

Common infrastructure classes and interfaces form the core API of the Runtime Editor. This includes selection, object lifecycle, tools, undo-redo, and drag-and-drop APIs.

Expose To Editor

Add the Assets/Battlehub/RTEditor/Runtime/RTCommon/ExposeToEditor component to any Game Object you want to make available for selection and editing.

Expose To Editor

  1. Selection Events:
  1. Bounds Configuration:

  1. Capabilities:

    • Can Transform, Can Inspect, Can Duplicate, Can Delete, Can Rename, Can Create Prefab, Show Selection Gizmo: These options are self-explanatory.

  2. Collider Management:

IOC

Assets/Battlehub/RTEditor/Runtime/RTCommon/Utils/IOC.cs is a simple IoC container implementation.

Methods:

Example 1:

using UnityEngine;
using Battlehub.RTCommon;

public interface IDependency { }

public class Dependency : MonoBehaviour, IDependency
{
    void Awake()
    {
        IOC.Register<IDependency>(this);
    }

    void OnDestroy()
    {
        IOC.Unregister<IDependency>(this);
    }
}

public class User : MonoBehaviour
{
    void Start()
    {
        IDependency dependency = IOC.Resolve<IDependency>();
    }
}

Example 2:

using UnityEngine;
using Battlehub.RTCommon;

[DefaultExecutionOrder(-1)]
public class Registrar : MonoBehaviour
{
    void Awake()
    {
        IOC.Register<IDependency>(() =>
        {
            GameObject go = new GameObject();
            return go.AddComponent<Dependency>();
        });
    }

    private void OnDestroy()
    {
        IOC.Unregister<IDependency>();
    }
}

public interface IDependency { }

public class Dependency : MonoBehaviour, IDependency
{
}

public class User : MonoBehaviour
{
    void Awake()
    {
        IDependency dependency = IOC.Resolve<IDependency>();
    }
}

Runtime Selection

The IRuntimeSelection interface is a key part of the Runtime Editor's API, providing functionality to manage and interact with the selection of objects within the editor. Here is a detailed description of its properties and methods:

Properties

Events

Methods

This interface allows for robust selection management within the Runtime Editor, supporting multiple selection states, undo functionality, and event-driven responses to selection changes.

using UnityEngine;
using Battlehub.RTCommon;

public class RuntimeSelectioExample : MonoBehaviour
{
    IRuntimeSelection m_selection;

    void Start()
    {
        var editor = IOC.Resolve<IRTE>();
        m_selection = editor.Selection;

        // Subscribe to the selection changed event
        m_selection.SelectionChanged += OnSelectionChanged;

        // Create a sample game object
        var go = GameObject.CreatePrimitive(PrimitiveType.Capsule);
        go.AddComponent<ExposeToEditor>();

        // Add object to the scene
        editor.AddGameObjectToHierarchy(go);

        // Select the game object
        m_selection.activeObject = go;
    }

    void OnDestroy()
    {
        if (m_selection != null)
        {
            m_selection.SelectionChanged -= OnSelectionChanged;
        }
    }

    void OnSelectionChanged(Object[] unselectedObjects)
    {
        if (unselectedObjects != null)
        {
            for (int i = 0; i < unselectedObjects.Length; ++i)
            {
                Object unselected = unselectedObjects[i];
                Debug.Log("Unselected: " + unselected.name);
            }
        }

        if (m_selection.objects != null)
        {
            for (int i = 0; i < m_selection.objects.Length; ++i)
            {
                Object selected = m_selection.objects[i];
                Debug.Log("Selected: " + selected.name);
            }
        }
    }
}

Note

For more examples, see Scene20 - Selection in the Example Scenes section.

Runtime Objects

The IRuntimeObjects interface is designed to provide events and methods for managing and responding to changes in runtime objects within the Runtime Editor environment.
This interface enables the monitoring of various object lifecycle events and component-related changes.

Events

Methods

Example Usage

using UnityEngine;
using Battlehub.RTCommon;

public class ListenAwakeEventExample : MonoBehaviour
{
    IRuntimeObjects m_object;

    void Start()
    {
        m_object = IOC.Resolve<IRTE>().Object;
        m_object.Awaked += OnObjectAwaked;

        GameObject go = new GameObject();
        go.AddComponent<ExposeToEditor>();
    }

    void OnDestroy()
    {
        if (m_object != null)
        {
            m_object.Awaked -= OnObjectAwaked;
        }
    }

    void OnObjectAwaked(ExposeToEditor obj)
    {
        Debug.Log("Awake: " + obj);
    }
}

Note

For more examples, see Scene24 - Object Lifecycle events in the Example Scenes section.

Runtime Tools

The RuntimeTools class allows you to track and manipulate the current tool, locking state, pivot modes, and other aspects of the editor's toolset.

Properties:

Events:

Additional Properties and Events:

Example Usage

Changing the Current Tool:

using UnityEngine;
using Battlehub.RTCommon;

public class SwitchToolBehaviour : MonoBehaviour
{
    void Start()
    {
        IRTE editor = IOC.Resolve<IRTE>();
        editor.Tools.Current = RuntimeTool.Rotate;
    }
}

Locking Axes for All Selected Objects:

using UnityEngine;
using Battlehub.RTCommon;

public class LockAxesForAllObjects : MonoBehaviour
{
    IRTE m_editor;
    void Start()
    {
        m_editor = IOC.Resolve<IRTE>();
        m_editor.Selection.SelectionChanged += OnSelectionChanged;
        m_editor.Tools.ToolChanged += OnToolChanged;
    }

    void OnDestroy()
    {
        if(m_editor != null)
        {
            m_editor.Selection.SelectionChanged -= OnSelectionChanged;
            m_editor.Tools.ToolChanged -= OnToolChanged;
        }
    }

    void OnToolChanged()
    {
        Lock();
    }

    void OnSelectionChanged(Object[] unselectedObjects)
    {
        Lock();
    }

    static void Lock()
    {
        IRTE editor = IOC.Resolve<IRTE>();
        editor.Tools.LockAxes = new LockObject
        {
            PositionY = true,
            RotationX = true,
            RotationZ = true
        };
    }
}

Note

For more examples, see Scene21 - Tools in the Example Scenes section.

Runtime Undo

The IRuntimeUndo interface is used to record changes, maintain the undo/redo stack, and perform undo and redo operations.

Properties:

Methods:

Events:

Example Usage

Recording a Value and then Undoing Changes:

using UnityEngine;
using System.Reflection;
using Battlehub.RTCommon;
using Battlehub.Utils;

public class RecordValueThenUndoChanges : MonoBehaviour
{
    IRuntimeUndo m_undo;

    [SerializeField]
    int m_value = 1;

    void Start()
    {
        m_undo = IOC.Resolve<IRTE>().Undo;
        m_undo.UndoCompleted += OnUndoCompleted;

        var valueInfo = Strong.MemberInfo((RecordValueThenUndoChanges x) => x.m_value);

        m_undo.BeginRecordValue(this, valueInfo);
        m_value = 2;
        m_undo.EndRecordValue(this, valueInfo);

        m_undo.Undo();
    }

    void OnDestroy()
    {
        if (m_undo != null)
        {
            m_undo.UndoCompleted -= OnUndoCompleted;
        }
    }

    void OnUndoCompleted()
    {
        Debug.Log(m_value); // 1
    }
}

Note

For more examples, see Scene25 - Undo & Redo in the Example Scenes section.

Drag And Drop

The IDragDrop interface is used as a common interface for all drag-and-drop operations.

Properties:

Methods:

Events:

Example Usage

In this example, we will handle a drag-and-drop operation into the console window (Add this script to the scene and try to drag and drop something from the Hierarchy or Project to the Console)

using Battlehub.RTCommon;
using UnityEngine;
using UnityEngine.EventSystems;

public class ConsoleDragDropHandler : MonoBehaviour
{
    IDragDrop m_dragDrop;
    RuntimeWindow m_target;

    void Start()
    {
        m_target = IOC.Resolve<IRTE>().GetWindow(RuntimeWindowType.Console);            
        m_dragDrop = IOC.Resolve<IRTE>().DragDrop;
        m_dragDrop.Drop += OnDrop;
    }

    void OnDestroy()
    {
        if(m_dragDrop != null)
        {
            m_dragDrop.Drop -= OnDrop;
        }
    }

    void OnDrop(PointerEventData pointerEventData)
    {
        if(m_target != null && m_target.IsPointerOver)
        {
            Debug.Log(m_dragDrop.DragObjects[0]);
        }
    }
}

Note

For more examples, see Scene11 - Handling Drag and Drop in the Example Scenes section.

Runtime Editor UI and Window System

Overview

The runtime editor UI is built using Unity's UGUI and includes three complex controls: Dock Panel, Tree View, and Menu.

The Runtime Editor Windows system is primarily managed using the IWindowManager interface. It allows for the creation of complex windows, such as inspectors or scenes, and simple dialogs, like messages or confirmation boxes. A key distinction is that dialogs cannot be docked and do not deactivate other windows, whereas windows can.
All windows and dialogs require a RuntimeWindow component to function correctly.

RuntimeWindow

The RuntimeWindow class provides essential properties and methods to manage window behavior, activation, and interaction within the Runtime Editor

Key Properties of RuntimeWindow

  1. CanActivate:
  1. ActivateOnAnyKey:
  1. Camera:
  1. Pointer:
  1. IOCContainer:
  1. WindowType:
  1. Index:
  1. CanvasGroup:

  1. Canvas:

    • Type: Canvas
    • Description: The parent canvas of the window.

  2. Background:

    • Type: Image
    • Description: The background image of the window.

  3. IsPointerOver:

    • Type: bool
    • Description: Indicates whether the pointer is currently over the window.

  4. ViewRoot:

    • Type: RectTransform
    • Description: The root transform for the window's view.

Example Usage

using Battlehub.RTCommon;
using UnityEngine;

public class CustomRuntimeWindow : RuntimeWindow
{
    protected override void OnActivated()
    {
        base.OnActivated();
        Debug.Log("Window Activated");
    }

    protected override void OnDeactivated()
    {
        base.OnDeactivated();
        Debug.Log("Window Deactivated");
    }
}

Built In Windows

The built-in windows component allows you to set up built-in windows, specify whether a window is a dialog, update their content prefab, tab header, and header text, set startup arguments, and specify the maximum number of windows that can be opened simultaneously.

Built In Windows

The BuiltInWindowNames class provides a list of names for built-in windows in the Runtime Editor. Here are some of the main built-in window names:

hljs public static class BuiltInWindowNames
{
    public readonly static string Game = RuntimeWindowType.Game.ToString().ToLower();
    public readonly static string Scene = RuntimeWindowType.Scene.ToString().ToLower();
    public readonly static string Hierarchy = RuntimeWindowType.Hierarchy.ToString().ToLower();
    public readonly static string ProjectTree = RuntimeWindowType.ProjectTree.ToString().ToLower();
    public readonly static string ProjectFolder = RuntimeWindowType.ProjectFolder.ToString().ToLower();
    public readonly static string Inspector = RuntimeWindowType.Inspector.ToString().ToLower();
    public readonly static string Console = RuntimeWindowType.Console.ToString().ToLower();
    public readonly static string Animation = RuntimeWindowType.Animation.ToString().ToLower();
    public readonly static string ToolsPanel = RuntimeWindowType.ToolsPanel.ToString().ToLower();
    public readonly static string ImportFile = RuntimeWindowType.ImportFile.ToString().ToLower();
    public readonly static string OpenProject = RuntimeWindowType.OpenProject.ToString().ToLower();
    public readonly static string About = RuntimeWindowType.About.ToString().ToLower();
    public readonly static string SaveFile = RuntimeWindowType.SaveFile.ToString().ToLower();
    public readonly static string OpenFile = RuntimeWindowType.OpenFile.ToString().ToLower();
    public readonly static string SelectColor = RuntimeWindowType.SelectColor.ToString().ToLower();
    //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    public readonly static string AssetDatabase = "assetdatabase";
    public readonly static string AssetDatabaseSaveScene = "assetdatabasesavescene";
    public readonly static string AssetDatabaseSave = "assetdatabasesave";
    public readonly static string AssetDatabaseSelect = "assetdatabaseselect";
    public readonly static string AssetDatabaseImportSource = "assetdatabaseimportsource";
    public readonly static string AssetDatabaseImport = "assetdatabaseimport";
    //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    public static string Project => ...
    public static string SaveScene => ...
    public static string SaveAsset => ...
    public static string SelectObject => ...
    public static string SelectAssetLibrary => ...
    public static string ImportAssets => ...
}

Window Manager

The IWindowManager interface provides a comprehensive set of methods for managing windows in the Runtime Editor. It allows you to create, activate, and manage both standard windows and dialog boxes. Below are some examples of how to use the IWindowManager to perform various tasks.

Properties and Methods

The IWindowManager interface includes various properties and methods to manage window layouts, components, and dialog boxes:

Properties

Methods

Note

For a complete list of properties and methods, refer to the IWindowManager interface definition.

Getting the Window Manager

To access the IWindowManager, use the IOC.Resolve<IWindowManager>() method:

using Battlehub.RTCommon;
using Battlehub.RTEditor;
using UnityEngine;

public class GetWindowManager : MonoBehaviour
{
    void Start()
    { 
        IWindowManager wm = IOC.Resolve<IWindowManager>();
    }
}

Showing a Message Box

You can display a message box with a header and text, and handle the OK button click event:

wm.MessageBox("Header", "Text", (sender, args) =>
{
    Debug.Log("OK Click");
});

Showing a Confirmation Dialog

You can display a confirmation dialog with custom buttons and handle the Yes and No button click events:

wm.Confirmation("Header", "Text",  
    (sender, args) =>
    {
        Debug.Log("Yes click");
    }, 
    (sender, args) =>
    {
        Debug.Log("No click");
    },
    "Yes", "No");

Activating a Window

To activate an existing window, use the ActivateWindow method with the name of the window:

wm.ActivateWindow(BuiltInWindowNames.Scene);

Creating a Window

To create a new window, use the CreateWindow method with the name of the window:

wm.CreateWindow(BuiltInWindowNames.Scene);

Creating a Dialog Window

To create a dialog window, use the CreateDialogWindow method with the name of the window and handle the OK and Cancel button click events:

IWindowManager wm = IOC.Resolve<IWindowManager>();
wm.CreateDialogWindow(BuiltInWindowNames.About, "Header",
    (sender, args) => { Debug.Log("OK"); }, 
    (sender, args) => { Debug.Log("Cancel"); });

Note

For examples, see Scene8 - Window Management in the Example Scenes section.

Main and Context Menu

The Runtime Editor uses the Menu control to implement both the main menu and context menus. To extend the main menu, you can create a static class with the [MenuDefinition] attribute and add static methods with the [MenuCommand] attribute.

Extending the Main Menu

To add new commands or modify existing ones, follow the steps below:

  1. Create a static class with the [MenuDefinition] attribute.
  2. Add static methods with the [MenuCommand] attribute to define new menu items or modify existing ones.
using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.UIControls.MenuControl;
using UnityEngine;

[MenuDefinition]
public static class MyMenu
{
    // Add new command to existing menu
    [MenuCommand("MenuWindow/Create My Window")]
    public static void CreateMyWindow()
    {
        Debug.Log("Create My Window");
    }

    // Add new command to new menu
    [MenuCommand("My Menu/My Submenu/My Command")]
    public static void CreateMyMenu()
    {
        Debug.Log("Create My Menu");
    }

    // Disable menu item
    [MenuCommand("My Menu/My Submenu/My Command", validate: true)]
    public static bool ValidateMyCommand()
    {
        Debug.Log("Disable My Command");
        return false;
    }

    // Replace existing menu item
    [MenuCommand("MenuFile/Close")]
    public static void Close()
    {
        Debug.Log("Intercepted");

        IRuntimeEditor rte = IOC.Resolve<IRuntimeEditor>();
        rte.Close();
    }

    // Hide existing menu item
    [MenuCommand("MenuHelp/About RTE", hide: true)]
    public static void HideAbout() { }
}

Main Menu

Instance Methods as Menu Commands

It is possible to use instance methods as menu commands. For this to work, the corresponding MonoBehaviour must exist in the scene.

using Battlehub.UIControls.MenuControl;
using UnityEngine;

[MenuDefinition]
public class MyMenu : MonoBehaviour
{
    // Add new command to new menu
    [MenuCommand("My Menu/My Submenu/My Command")]
    public void CreateMyMenu()
    {
        Debug.Log("Create My Menu");
    }

    // Disable menu item
    [MenuCommand("My Menu/My Submenu/My Command", validate: true)]
    public bool ValidateMyCommand()
    {
        Debug.Log("Disable My Command");
        return false;
    }
}

Use the [MenuDefinition] attribute with the sceneName parameter to specify the scene. This way, the menu will only exist in the Unity scene with the corresponding name.

using Battlehub.UIControls.MenuControl;
using UnityEngine;

[MenuDefinition(sceneName:"Scene")]
public class MyMenu : MonoBehaviour
{

    // Add new command to new menu
    [MenuCommand("My Menu/My Submenu/My Command")]
    public void CreateMyMenu()
    {
        Debug.Log("Create My Menu");
    }
}

Note

For examples, see Scene9 - Extending Main Menu in the Example Scenes section.

Opening a Context Menu with Custom Commands

The IContextMenuModel interface defines the structure for managing context menus within the runtime editor. It provides methods and events to create, open, and manage context menus dynamically.

Events

Methods

To open a context menu with custom commands, follow these steps:

  1. Define a class with methods to open the context menu.
  2. Use the IContextMenuModel interface to create and show the context menu with the defined commands.
using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.RTEditor.Models;
using UnityEngine;

public class MyContextMenu : MonoBehaviour 
{
    private void Update()
    {
        if (Input.GetKeyDown(KeyCode.Space))
        {
            OpenContextMenu();
        }
    }

    public void OpenContextMenu()
    {
        IContextMenuModel contextMenu = IOC.Resolve<IContextMenuModel>();

        contextMenu.Show(
            new ContextMenuItem 
            { 
                Path = "My Command 1",
                Action = arg =>
                {
                    Debug.Log("Run My Command1");

                    var editor = IOC.Resolve<IRuntimeEditor>();
                    Debug.Log(editor.Selection.activeGameObject);
                }
            },
            new ContextMenuItem
            {
                Path = "My Command 2",
                Action = arg => Debug.Log("Run My Command2"),
                Validate = arg => arg.IsValid = false
            });
    }
}

Basically, the same can be done using the following syntax:

hljs using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.RTEditor.Models;
using UnityEngine;

public class MyContextMenu : MonoBehaviour 
{
    private void Update()
    {
        if (Input.GetKeyDown(KeyCode.Space))
        {
            OpenContextMenu();
        }
    }

    public void OpenContextMenu()
    {
        var contextMenu = IOC.Resolve<IContextMenuModel>();
        contextMenu.Open += OnContextMenuOpen;
        contextMenu.Show();
        contextMenu.Open -= OnContextMenuOpen;
    }

    private void OnContextMenuOpen(object sender, ContextMenuArgs e)
    {
        if (e.WindowName == BuiltInWindowNames.Scene)
        {
            e.AddMenuItem("My Command 1", arg =>
            {
                Debug.Log("Run My Command1");
                var editor = IOC.Resolve<IRuntimeEditor>();
                Debug.Log(editor.Selection.activeGameObject);
            });

            e.AddMenuItem("My Command 2",
                 arg => Debug.Log("Run My Command2"),
                 arg => arg.IsValid = false);
        }
    }
}

Context Menu

Note

For examples, see Scene10 - Extending Context Menu in the Example Scenes section.

Editor Extension

The EditorExtension class serves as a recommended base class for writing Runtime Editor Extensions. It provides two useful methods that can be overridden: OnInit() and OnCleanup(). These methods are intended for initializing and cleaning up the extension, respectively.

Methods

Example

using Battlehub.RTCommon;
using Battlehub.RTEditor;

public class EditorExtensionExample : EditorExtension
{
    protected override void OnInit()
    {
        var editor = IOC.Resolve<IRuntimeEditor>();

        // Do extension initialization here
        Debug.Log("Editor extension initialized.");
    }

    protected override void OnCleanup()
    {
        // Do extension cleanup here
        Debug.Log("Editor extension cleaned up.");
    }
}

Additional Convenience Extension Base Classes

There are three additional convenience extension base classes:

  1. LayoutExtension
  2. RuntimeWindowExtension
  3. SceneComponentExtension

LayoutExtension

The LayoutExtension class provides four additional methods for handling window registration, layout building, and events for additional handling before and after the layout.

Methods
Example
using Battlehub.RTCommon;
using Battlehub.RTEditor;
using UnityEngine;

public class LayoutExtensionExample : LayoutExtension
{
    [SerializeField]
    private GameObject m_sceneWindow = null;

    protected override void OnInit()
    {
    }

    protected override void OnCleanup()
    {
    }

    protected override void OnRegisterWindows(IWindowManager wm)
    {
        if (m_sceneWindow != null)
        {
            wm.OverrideWindow(BuiltInWindowNames.Scene, m_sceneWindow);
        }
    }

    protected override void OnBeforeBuildLayout(IWindowManager wm)
    {
        // Hide header toolbar
        wm.OverrideTools(null);
    }

    protected override void OnAfterBuildLayout(IWindowManager wm)
    {
        base.OnAfterBuildLayout(wm);
    }

    protected override LayoutInfo GetLayoutInfo(IWindowManager wm)
    {
        // Initializing a layout with one window - Scene
        LayoutInfo layoutInfo = wm.CreateLayoutInfo(BuiltInWindowNames.Scene);
        layoutInfo.IsHeaderVisible = false;

        return layoutInfo;
    }
}

RuntimeWindowExtension

The RuntimeWindowExtension class calls Extend and Cleanup methods for a specific window type.

Methods
Example
using Battlehub.RTCommon;
using Battlehub.RTEditor;
using UnityEngine;

public class RuntimeWindowExtensionExample : RuntimeWindowExtension
{
    [SerializeField]
    private RectTransform m_layer = null;

    public override string WindowTypeName => BuiltInWindowNames.Scene;

    protected override void Extend(RuntimeWindow window)
    {
        Instantiate(m_layer, window.ViewRoot).Stretch();
    }

    protected override void Cleanup(RuntimeWindow window)
    {
        base.Cleanup(window);
    }
}

SceneComponentExtension

The SceneComponentExtension class allows you to extend the scene view when it is activated and perform cleanup when it is deactivated.

Methods
Example
using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.RTHandles;
using UnityEngine;

public class SceneComponentExtensionExample : SceneComponentExtension
{
    protected override void OnSceneActivated(IRuntimeSceneComponent sceneComponent)
    {
        base.OnSceneActivated(sceneComponent);

        sceneComponent.PositionHandle.Drag.AddListener(OnDrag);
    }

    protected override void OnSceneDeactivated(IRuntimeSceneComponent sceneComponent)
    {
        base.OnSceneDeactivated(sceneComponent);

        sceneComponent.PositionHandle.Drag.RemoveListener(OnDrag);
    }

    private void OnDrag(BaseHandle handle)
    {
        foreach (Transform target in handle.ActiveTargets)
        {
            Vector3 p = target.position;
            target.position = new Vector3(Mathf.Round(p.x), Mathf.Round(p.y), Mathf.Round(p.z));
        }
    }
}

Window

Window

A typical Runtime Editor Window consists of several parts, including a window prefab with a RuntimeWindow component, a frame, background, and view.
It also incorporates a View, ViewModel, and ViewBinding, built on top of UnityWeld.dll.
This structure ensures a modular and flexible design, allowing for a seamless integration of UI components and binding logic.

View-ViewModel-ViewBinding Architecture

The window uses the Model-View-ViewModel (MVVM) pattern, facilitated by UnityWeld.dll, to ensure a clear separation of concerns and enhance maintainability.

  1. View: Contains the UI elements and visual components.
  2. ViewModel: Holds the logic and data for the view, acting as an intermediary between the view and the model.
  3. ViewBinding: Binds the view to the ViewModel, ensuring that changes in the ViewModel are reflected in the view and vice versa.

UnityWeld

https://github.com/Battlehub0x/Unity-Weld?tab=readme-ov-file

View

The View class in the Runtime Editor framework is responsible for managing the visual representation and interaction logic of editor windows. It handles various events related to dragging, dropping, activating, and deactivating, and it provides mechanisms for binding the view to a ViewModel.

Key Properties

  1. DragObjects: An enumerable property that holds the objects being dragged.
  2. CanDropExternalObjects: A boolean property indicating whether external drag objects can be dropped.
  3. IsDraggingOver: A boolean property indicating whether a drag operation is currently over the view.
  4. ViewInput: A protected property providing access to the ViewInput component.
  5. Window: A protected property providing access to the associated RuntimeWindow.
  6. Editor: A protected property providing access to the IRTE instance.

Key Events

  1. SelectAll: An event triggered to select all items.
  2. Duplicate: An event triggered to duplicate items.
  3. Delete: An event triggered to delete items.
  4. DragEnter: An event triggered when a drag operation enters the view.
  5. DragLeave: An event triggered when a drag operation leaves the view.
  6. Drag: An event triggered during a drag operation.
  7. Drop: An event triggered when a drop operation occurs.
  8. DragObjectsChanged: An event triggered when the DragObjects property changes.
  9. Activated: An event triggered when the view is activated.
  10. Deactivated: An event triggered when the view is deactivated.

Key Methods

  1. Awake(): Initializes the view, setting up event handlers for the associated RuntimeWindow.
  2. OnEnable(): Called when the view is enabled.
  3. Start(): Ensures the ViewInput component is present.
  4. OnDisable(): Called when the view is disabled.
  5. OnDestroy(): Cleans up event handlers and references when the view is destroyed.
  6. OnDragEnter(PointerEventData): Handles the drag enter event, updating the DragObjects property and setting the cursor.
  7. OnDragLeave(PointerEventData): Handles the drag leave event, resetting the DragObjects property and setting the cursor.
  8. OnDrag(PointerEventData): Handles the drag event.
  9. OnDrop(PointerEventData): Handles the drop event, resetting the DragObjects property.
  10. OnActivated(object, EventArgs): Handles the activation event.
  11. OnDeactivated(object, EventArgs): Handles the deactivation event.

Utility Methods

  1. ReplaceWith(Component, bool): Replaces the current View component with a new one of type T.
  2. ReplaceWith(GameObject, bool): Replaces the current View component on the specified GameObject with a new one of type T.
  3. ReplaceWith(Type, Component, bool): Replaces the current View component with a new one of the specified type.
  4. ReplaceWith(Type, GameObject, bool): Replaces the current View component on the specified GameObject with a new one of the specified type.

Example Usage

using Battlehub.RTCommon;
using Battlehub.RTEditor.Views;
using UnityEngine;
using UnityEngine.EventSystems;

public class CustomView : View
{
    protected override void Awake()
    {
        base.Awake();
        Debug.Log("CustomView Awake");
    }

    protected override void OnEnable()
    {
        base.OnEnable();
        Debug.Log("CustomView OnEnable");
    }

    protected override void OnDisable()
    {
        base.OnDisable();
        Debug.Log("CustomView OnDisable");
    }

    protected override void OnDragEnter(PointerEventData pointerEventData)
    {
        base.OnDragEnter(pointerEventData);
        Debug.Log("Drag entered CustomView");
    }

    protected override void OnDrop(PointerEventData pointerEventData)
    {
        base.OnDrop(pointerEventData);
        Debug.Log("Dropped on CustomView");
    }
}

ViewModel

The ViewModel base class is a foundational component in the MVVM architecture used within the Runtime Editor. It provides essential properties and methods to facilitate the interaction between the view and the underlying data and logic. This class inherits from ViewModelBase and uses the UnityWeld.Binding attribute for data binding.

Key Properties

  1. CanDropExternalObjects: A boolean property indicating whether external drag objects can be dropped. It uses RaisePropertyChanged to notify the view of any changes.
  2. ExternalDragObjects: An enumerable property that holds the external drag objects.
  3. Editor: Provides access to the IRuntimeEditor instance.
  4. Localization: Provides access to the ILocalization instance.
  5. WindowManager: Provides access to the IWindowManager instance.
  6. Selection: Represents the current runtime selection.
  7. Undo: Represents the undo functionality.
  8. SelectionOverride: Allows overriding the default selection behavior.
  9. UndoOverride: Allows overriding the default undo behavior.
  10. WindowName: The name of the window associated with this ViewModel.

Key Methods

  1. Awake(): Initializes the Editor, Localization, and WindowManager properties and sets the WindowName if the ViewModel is attached to a RuntimeWindow.

  2. OnEnable(): Sets up the Selection and Undo properties.

  3. OnDisable(): Called when the ViewModel is disabled.

  4. OnDestroy(): Cleans up references to the Editor, Localization, WindowManager, Selection, and Undo.

  5. SetBusy(): Sets the editor to a busy state.

  6. OnActivated(): Called when the ViewModel is activated.

  7. OnDeactivated(): Called when the ViewModel is deactivated.

  8. OnSelectAll(): Handles the select all action.

  9. OnDelete(): Handles the delete action.

  10. OnDuplicate(): Handles the duplicate action.

  11. OnExternalObjectEnter(): Called when an external object enters the drop area.

  12. OnExternalObjectLeave(): Called when an external object leaves the drop area.

  13. OnExternalObjectDrag(): Called during the dragging of an external object.

  14. OnExternalObjectDrop(): Called when an external object is dropped.

  15. RaisePropertyChanged(string propertyName):

  1. RaisePropertyChanged(PropertyChangedEventArgs args):
  1. ReplaceWith(UnityEngine.Component component) where T : ViewModelBase:
  1. ReplaceWith(GameObject go) where T : ViewModelBase:
  1. ReplaceWith(Type type, UnityEngine.Component component):
  1. ReplaceWith(Type type, GameObject go):

Example Usage

[Binding]
public class MyViewModel : ViewModel
{
    private bool m_isEnabled;

    [Binding]
    public bool IsEnabled
    {
        get { return m_isEnabled; }
        set
        {
            if (m_isEnabled != value)
            {
                m_isEnabled = value;
                RaisePropertyChanged(nameof(IsEnabled));
            }
        }
    }

    protected override void OnActivated()
    {
        base.OnActivated();
        Debug.Log("ViewModel activated.");
    }

    protected override void OnDeactivated()
    {
        base.OnDeactivated();
        Debug.Log("ViewModel deactivated.");
    }

    [Binding]
    public override void OnSelectAll()
    {
        base.OnSelectAll();
        Debug.Log("Select All action triggered.");
    }

    [Binding]
    public override void OnDelete()
    {
        base.OnDelete();
        Debug.Log("Delete action triggered.");
    }
}

HierarchicalDataViewModel

The HierarchicalDataViewModel<T> class is a base view model class used for managing hierarchical data structures in the Runtime Editor, such as those found in Hierarchy and Project windows.
This class provides mechanisms for managing tree-like data structures and handling common operations like selection, drag-and-drop, and context menus.

Key Properties

Key Events

Key Methods

  1. RaiseHierarchicalDataChanged: Raises the HierarchicalDataChanged event with the specified arguments.
  2. RaiseItemAdded: Raises the HierarchicalDataChanged event to indicate an item was added.
  3. RaiseItemInserted: Raises the HierarchicalDataChanged event to indicate an item was inserted.
  4. RaiseItemRemoved: Raises the HierarchicalDataChanged event to indicate an item was removed.
  5. RaiseRemoveSelected: Raises the HierarchicalDataChanged event to indicate selected items should be removed.
  6. RaiseNextSiblingChanged: Raises the HierarchicalDataChanged event to indicate the next sibling of an item has changed.
  7. RaisePrevSiblingChanged: Raises the HierarchicalDataChanged event to indicate the previous sibling of an item has changed.
  8. RaiseParentChanged: Raises the HierarchicalDataChanged event to indicate the parent of an item has changed.
  9. RaiseExpand: Raises the HierarchicalDataChanged event to indicate an item should be expanded.
  10. RaiseCollapse: Raises the HierarchicalDataChanged event to indicate an item should be collapsed.
  11. RaiseSelect: Raises the HierarchicalDataChanged event to select items.
  12. RaiseReset: Raises the HierarchicalDataChanged event to reset the hierarchical data.
  13. RaiseDataBindVisible: Raises the HierarchicalDataChanged event to rebind the visible data.

Context Menu Handling

  1. GetContextMenuAnchor: Returns the context menu anchor, which includes the target item and selected items.
  2. OpenContextMenu: Opens the context menu and populates it with items.
  3. OnContextMenu: Method for adding items to the context menu. Override this method to customize the context menu.

IHierarchicalData Implementation

  1. GetChildren: Returns the children of a given parent item.
  2. GetFlags: Returns the hierarchical data flags.
  3. GetItemFlags: Returns the flags for a specific item.
  4. GetParent: Returns the parent of a given item.
  5. HasChildren: Indicates whether a given item has children.
  6. IndexOf: Returns the index of a child item within its parent.
  7. Expand: Expands a given item.
  8. Collapse: Collapses a given item.
  9. Select: Selects the specified items.

Bound UnityEvent Handlers

  1. OnItemsBeginDrag: Called when items begin to be dragged.
  2. OnItemDragEnter: Called when an item drag enters the view.
  3. OnItemDragLeave: Called when an item drag leaves the view.
  4. OnItemsDrag: Called when items are being dragged.
  5. OnItemsSetLastChild: Called to set the last child during drag-and-drop.
  6. OnItemsSetNextSibling: Called to set the next sibling during drag-and-drop.
  7. OnItemsSetPrevSibling: Called to set the previous sibling during drag-and-drop.
  8. OnItemsCancelDrop: Called to cancel the drop operation.
  9. OnItemsBeginDrop: Called when items begin to be dropped.
  10. OnItemsDrop: Called when items are dropped.
  11. OnItemsEndDrag: Called when items finish being dragged.
  12. OnItemsRemoved: Called when items are removed.
  13. OnItemBeginEdit: Called when an item begins editing.
  14. OnItemEndEdit: Called when an item ends editing.
  15. OnItemHold: Called when an item is held.
  16. OnItemClick: Called when an item is clicked.
  17. OnItemDoubleClick: Called when an item is double-clicked.
  18. OnHold: Called when the view is held.
  19. OnClick: Called when the view is clicked.

Example Usage

using Battlehub.RTEditor.ViewModels;
using System.Collections.Generic;
using UnityWeld.Binding;

[Binding]
public class MyHierarchicalDataViewModel : HierarchicalDataViewModel<MyItemType>
{
    public override IEnumerable<MyItemType> GetChildren(MyItemType parent)
    {
        // Return children of the parent item
    }

    public override void OnContextMenu(List<MenuItemViewModel> menuItems)
    {
        // Add custom menu items
        menuItems.Add(new MenuItemViewModel
        {
            Path = "Custom Command",
            Action = cmd => Debug.Log("Custom command executed")
        });
    }

    protected override void OnSelectedItemsChanged(IEnumerable<MyItemType> unselectedObjects, IEnumerable<MyItemType> selectedObjects)
    {
        // Handle selection change
    }
}

Custom windows

To create a custom window, follow these steps:

  1. Click Tools -> Runtime Editor -> Create Custom Window

  2. Enter the Name

  1. Enter the Namespace
  1. Add RegisterMyCustomWindow Component
  1. Drag & Drop Prefab
  1. Click Play
  1. Open Custom Window

Click Create Custom Window
Register My Custom Window
Register My Custom Window

Extending Existing Windows

There are several possible approaches for extending existing windows in the Runtime Editor.

1. Override the Window Prefab

First, locate the window prefab you want to override or extend. Create a prefab variant and set the corresponding field in the BuiltInWindows component to your custom window.
Extending Window By Overriding Prefab

2. Override Programmatically Using Layout Extension

You can also achieve this programmatically using a LayoutExtension.

using Battlehub.RTEditor;
using UnityEngine;

public class MyLayoutExtension : LayoutExtension
{
    [SerializeField]
    private GameObject m_myHierarchyWindow;

    protected override void OnRegisterWindows(IWindowManager wm)
    {
        wm.OverrideWindow(BuiltInWindowNames.Hierarchy, 
            new WindowDescriptor { ContentPrefab = m_myHierarchyWindow });
    }
}

3. Override ViewModel or View Using RuntimeWindowExtension and ReplaceWith Method

You can override the ViewModel or View of a window using a RuntimeWindowExtension and the ReplaceWith method.

using Battlehub.RTCommon;
using Battlehub.RTEditor.ViewModels;

public class ExtendHierarchyWindow : RuntimeWindowExtension
{
    public override string WindowTypeName => BuiltInWindowNames.Hierarchy;

    protected override void Extend(RuntimeWindow window)
    {
        ViewModelBase.ReplaceWith<HierarchyViewModelWithContextMenu>(window);
    }
}

using Battlehub.RTEditor.ViewModels;
using System.Collections.Generic;
using UnityEngine;
using UnityWeld.Binding;

namespace Battlehub.RTEditor.Examples.Scene10
{

    [Binding]
    public class HierarchyViewModelWithContextMenuExample : HierarchyViewModel
    {
        protected override void OnContextMenu(List<MenuItemViewModel> menuItems)
        {
            base.OnContextMenu(menuItems);
            menuItems.Clear();

            MenuItemViewModel myCommand = new MenuItemViewModel 
            { 
                Path = "My Context Menu Cmd", Command = "My Cmd Args" 
            };
            myCommand.Action = MenuCmd;
            myCommand.Validate = ValidateMenuCmd;
            menuItems.Add(myCommand);
        }

        private void ValidateMenuCmd(MenuItemViewModel.ValidationArgs args)
        {
            if (!HasSelectedItems)
            {
                args.IsValid = false;
            }
        }

        private void MenuCmd(string arg)
        {
            Debug.Log($"My Context Menu Command with {arg}");
        }
    }
}

Note
You can combine the above approaches.

Note
Most of the runtime editor windows follow the architecture described in the window section.

Note
For more examples, see Scene10 - Extending Context Menu in the Example Scenes section.

Overriding the Default Layout

To override the default layout, follow these steps:

  1. Create a Script Derived from LayoutExtension:
    Define a new script that inherits from LayoutExtension.

  2. Override GetLayoutInfo Method:
    Implement the GetLayoutInfo method to specify the custom layout.

  3. Add Script to GameObject:
    Create a new empty GameObject in your scene and attach the ThreeColumnsLayoutExample script to it.

Example

Here is an example script that creates a three-column layout (inspector, scene, hierarchy):

using Battlehub.UIControls.DockPanels;

namespace Battlehub.RTEditor.Examples.Layout
{
    /// <summary>
    /// Creates three columns layout (inspector, (scene, hierarchy))
    /// </summary>
    public class ThreeColumnsLayoutExample : LayoutExtension
    { 
        protected override LayoutInfo GetLayoutInfo(IWindowManager wm)
        {
            LayoutInfo scene = wm.CreateLayoutInfo(BuiltInWindowNames.Scene);
            scene.IsHeaderVisible = true;

            LayoutInfo hierarchy = wm.CreateLayoutInfo(BuiltInWindowNames.Hierarchy);
            LayoutInfo inspector = wm.CreateLayoutInfo(BuiltInWindowNames.Inspector);

            // Defines a region divided into two equal parts (ratio 1 / 2)
            LayoutInfo sceneAndHierarchy = 
                LayoutInfo.Horizontal(scene, hierarchy, ratio: 1/2.0f);

            // Defines a region divided into two parts 
            // 1/3 for the inspector and 2/3 for the scene and hierarchy)
            LayoutInfo layoutRoot = 
                LayoutInfo.Horizontal(inspector, sceneAndHierarchy, ratio: 1/3.0f);

            return layoutRoot;
        }
    }
}

Add Three Columns Layout Example

Result

Note !!!
Make sure to remove conflicting layout extensions (like AutoSaveLayout).

Remove Coflicting Layout Extensions

Note

For examples, see
Scene1 - Minimal,
Scene2 - Minimal Mobile,
Scene4 - Multiple Scenes,
Scene5 - Layout SaveLoad

LayoutInfo Methods

The LayoutInfo class provides three main methods to construct various types of layouts. These methods allow you to create complex layouts by splitting parent containers or grouping windows into tabs. Here's a description of each method:

Vertical Split

The Vertical method splits the parent container into two parts: one on top of the other. The specified ratio determines the size of the parts. A smaller ratio results in a smaller upper part.

public static LayoutInfo Vertical(LayoutInfo top, LayoutInfo bottom, float ratio = 0.5f)
{
    return new LayoutInfo(true, top, bottom, ratio);
}

Horizontal Split

The Horizontal method splits the parent container into two parts: one next to the other. The specified ratio determines the size of the parts. A smaller ratio results in a smaller left part.

public static LayoutInfo Horizontal(LayoutInfo left, LayoutInfo right, float ratio = 0.5f)
{
    return new LayoutInfo(false, left, right, ratio);
}

Tab Group

The Group method does not split the parent container. Instead, it creates a tab group, grouping multiple LayoutInfo instances into tabs within the same container.

public static LayoutInfo Group(params LayoutInfo[] tabGroup)
{
    return new LayoutInfo(tabGroup);
}

Vertical Split Example

Splitting a container into a scene view on top and a hierarchy view on the bottom with a 70% and 30% ratio respectively.

LayoutInfo layout = LayoutInfo.Vertical(sceneViewLayout, hierarchyViewLayout, 0.7f);

Horizontal Split Example

Splitting a container into an inspector view on the left and a scene view on the right with a 30% and 70% ratio respectively.

LayoutInfo layout = LayoutInfo.Horizontal(inspectorViewLayout, sceneViewLayout, 0.3f);

Tab Group Example

Grouping an inspector view and a console view into a single tab group.

LayoutInfo layout = LayoutInfo.Group(inspectorViewLayout, consoleViewLayout);

Overriding Scene Parameters

  1. Create the Script: Save the below code in a new C# script named ScenesSetupExample.cs.
  2. Attach the Script: Add the ScenesSetupExample script to a new GameObject in your scene.

Example

using Battlehub.RTCommon;
using Battlehub.RTHandles;
using UnityEngine;

namespace Battlehub.RTEditor.Examples.SceneSetup
{
    /// <summary>
    /// This extension initializes 2D scene window 
    /// </summary>
    public class SceneSetupExample : RuntimeWindowExtension
    {
        /// <summary>
        /// Type of window to be extended
        /// </summary>
        public override string WindowTypeName => BuiltInWindowNames.Scene;

        protected override void Extend(RuntimeWindow window)
        {
            // Get a reference to the IRuntimeSceneComponent of the window
            IRuntimeSceneComponent sceneComponent = 
            window.IOCContainer.Resolve<IRuntimeSceneComponent>();

            // This is the point the camera looks at and orbits around
            sceneComponent.Pivot = Vector3.zero;

            // Switch the scene component and scene camera to orthographic mode
            sceneComponent.IsOrthographic = true;

            // Disable scene gizmo
            sceneComponent.IsSceneGizmoEnabled = false;

            // Disable rotation
            sceneComponent.CanRotate = false;

            // Disable free move
            sceneComponent.CanFreeMove = false;

            // Prevent camera position changes when zooming in and out
            sceneComponent.ChangeOrthographicSizeOnly = true;

            // Set initial orthographic size
            sceneComponent.OrthographicSize = 5.0f;

            // Set camera position according to window.Args
            const float distance = 100;
            sceneComponent.CameraPosition = -Vector3.forward * distance;
        }
    }
}

Explanation

Override Scene Params

Overriding Tools Panel

To override the tools panel in the runtime editor, follow these steps:

  1. Create a script named ToolsPanelOverride.
  2. Create a new GameObject and add the ToolsPanelOverride component to it.
  3. Set the Tools Prefab field in the Inspector.

Here's an example script demonstrating how to override the tools panel:

using Battlehub.RTEditor;
using UnityEngine;

public class ToolsPanelOverride : LayoutExtension
{
    [SerializeField]
    private Transform m_toolsPrefab = null;

    protected override void OnBeforeBuildLayout(IWindowManager wm)
    {
        wm.OverrideTools(m_toolsPrefab);
    }
}

Override Tools

Note

The original tools view can be found in: Assets/Battlehub/RTEditor/Content/Runtime/RTEditor/Prefabs/Views/ToolsView.prefab

Setting ui scale

Overriding UI Scale

To override the UI scale in the runtime editor, follow these steps:

  1. Create a script named UIScaleOverride.
  2. Create a new GameObject and add the UIScaleOverride component to it.
  3. Set the desired scale in the Inspector.

Example Script

Here's an example script demonstrating how to override the UI scale:

using Battlehub.RTCommon;
using Battlehub.RTEditor;
using UnityEngine;

public class UIScaleOverride : LayoutExtension
{
    [SerializeField]
    private float Scale = 2;

    protected override void OnInit()
    {
        ISettingsComponent settings = IOC.Resolve<ISettingsComponent>();
        settings.UIScale = Scale;
    }
}

Before UI Scale Override

Before UI Scale Override

After UI Scale Override

After UI Scale Override

Overriding the Theme

To override the theme in the runtime editor, follow these steps:

  1. Create a script named OverrideTheme.
  2. Create a new GameObject and add the OverrideTheme component to it.
  3. Assign a ThemeAsset to the m_theme field in the Inspector.

Example Script

Here's an example script demonstrating how to override the theme:

using Battlehub.RTCommon;
using UnityEngine;

namespace Battlehub.RTEditor.Demo
{
    public class OverrideTheme : EditorExtension
    {
        [SerializeField]
        private ThemeAsset m_theme;

        protected override void OnInit()
        {
            ISettingsComponent settings = IOC.Resolve<ISettingsComponent>();
            settings.SelectedTheme = m_theme;
        }
    }
}

Override Theme

Inspector View

The main purpose of the inspector is to create different editors depending on the type of selected object and its components. Here is a general idea of what is happening:

  1. GameObject Selection: When the user selects a GameObject, the inspector creates a GameObject editor.
  2. Component Editors Creation: The GameObject editor creates component editors for each component attached to the selected GameObject.
  3. Property Editors Creation: Each component editor creates property editors for the properties of the component.

Insepector

Inspector Editors

In the Assets/Battlehub/RTEditor/Content/Runtime/RTEditor/Prefabs/Editors folder, you can find various editor prefabs like GameObjectEditor, AssetEditor, LayerEditor, and MaterialEditor.
These editors are used by the inspector to create specific editing ui based on the selected object's type and its components.
Insepector

Property Editors

Property editors, created by component editors, are located in the Assets/Battlehub/RTEditor/Content/Runtime/RTEditor/Prefabs/Editors/PropertyEditors folder.
These editors provide specific ui for editing individual properties of components within the inspector.
Inspector

Inspector Configuration

To configure the editors used by the inspector, follow these steps:

  1. Click Tools -> Runtime Editor -> Inspector Configuration.

    Inspector Configuration

  2. The configuration window has five sections:

    • Object Editors: Select which editor to use for Game Objects and Asset Editors.
    • Property Editors: Select which editors to use for component properties.
    • Material Editors: Select which editors to use for materials.
    • Standard Component Editors: Select which editors to use for standard components.
    • Script Editors: Select which editors to use for scripts.

  3. After selecting and enabling the desired component editors, click the Save Editors Map button.

    Save Editors Map

Register Editors Programatically

To register property editors programmatically, you need to create a script that defines and registers your custom property editors. Below is an example demonstrating how to achieve this:

using Battlehub.RTCommon;
using Battlehub.RTEditor;
using UnityEngine;

public class RegisterPropertyEditorsExample : EditorExtension
{
    [SerializeField]
    private GameObject m_vector3Editor = null;

    [SerializeField]
    private GameObject m_vector2Editor = null;

    protected override void OnInit()
    {
        base.OnInit();

        IEditorsMap editorsMap = IOC.Resolve<IEditorsMap>();
        if (m_vector3Editor != null)
        {
            editorsMap.RemoveMapping(typeof(Vector3));
            editorsMap.AddMapping(typeof(Vector3), m_vector3Editor, true, true);
            EnableStyling(m_vector3Editor);
        }

        if (m_vector2Editor != null)
        {
            editorsMap.RemoveMapping(typeof(Vector2));
            editorsMap.AddMapping(typeof(Vector2), m_vector2Editor, true, true);
            EnableStyling(m_vector2Editor);
        }
    }
}

Steps to Register Property Editors Programmatically

  1. Create a New Script: Create a new C# script, for example, RegisterPropertyEditorsExample.cs.

  2. Implement the Script: Implement the script as shown above, registering your custom property editors.

  3. Attach the Script to a GameObject: Create a new GameObject in your scene and attach the RegisterPropertyEditorsExample script to it

To register a custom component editor programmatically, you can use a similar approach to the one used for registering property editors. Below is an example demonstrating how to achieve this:

using Battlehub.RTCommon;
using Battlehub.RTEditor;
using UnityEngine;

public class CustomComponentEditorInit : EditorExtension
{
    [SerializeField]
    private GameObject m_terrainComponentEditor = null;

    protected override void OnInit()
    {
        base.OnInit();

        IEditorsMap editorsMap = IOC.Resolve<IEditorsMap>();
        if (m_terrainComponentEditor != null)
        {
            if (!editorsMap.HasMapping(typeof(Terrain)))
            {
                editorsMap.AddMapping(typeof(Terrain), 
                    m_terrainComponentEditor, enabled: true, isPropertyEditor: false);
            }
        }
    }
}

Component Properties Visiblity

To select the properties displayed by the component editor, you need to create a class that inherits from ComponentDescriptorBase<>. Implement the GetProperties method to return PropertyDescriptors for all properties that will be present in the component editor UI.

For example, suppose you have the following component, and you want to display Field1, Property1, and a button that will call Method(). Field2 and Property2 must stay hidden.

public class MyComponent : MonoBehaviour
{
    public string Field1;

    public string Field2;

    public string Property1
    {
        get;
        set;
    }

    public string Property2
    {
        get;
        set;
    }

    public void Method()
    {
        Debug.Log("Method");
    }
}

To achieve this, create the following component descriptor:

using Battlehub.RTEditor;
using Battlehub.Utils;
using UnityEngine;

public class MyComponentDescriptor : ComponentDescriptorBase<MyComponent>
{
    public override PropertyDescriptor[] GetProperties(ComponentEditor editor, object converter)
    {
        var field1 = Strong.MemberInfo((MyComponent x) => x.Field1);
        var property1 = Strong.MemberInfo((MyComponent x) => x.Property1);
        var method = Strong.MethodInfo((MyComponent x) => x.Method());

        return new[]
        {
            new PropertyDescriptor("My Field", editor.Components, field1),
            new PropertyDescriptor("My Property", editor.Components, property1),
            new PropertyDescriptor("Click Me!", editor.Components, method),
        };
    }
}

And enable the ComponentEditor using the Inspector Configuration Window.

My Component

Here is more complex example of a TransformComponentDescriptor:

using UnityEngine;
using System.Reflection;
using Battlehub.Utils;
using Battlehub.RTCommon;

namespace Battlehub.RTEditor
{
    public class TransformComponentDescriptor : ComponentDescriptorBase<Transform>
    {
        public override object CreateConverter(ComponentEditor editor)
        {
            object[] converters = new object[editor.Components.Length];
            Component[] components = editor.Components;
            for (int i = 0; i < components.Length; ++i)
            {
                Transform transform = (Transform)components[i];
                if (transform != null)
                {
                    converters[i] = new TransformPropertyConverter
                    {
                        ExposeToEditor = transform.GetComponent<ExposeToEditor>()
                    };
                }
            }
            return converters;
        }

        public override PropertyDescriptor[] GetProperties(
            ComponentEditor editor, object converter)
        {
            object[] converters = (object[])converter;

            MemberInfo position = Strong.PropertyInfo(
                (Transform x) => x.localPosition, "localPosition");
            MemberInfo positionConverted = Strong.PropertyInfo(
                (TransformPropertyConverter x) => x.LocalPosition, "LocalPosition");
            MemberInfo rotation = Strong.PropertyInfo(
                (Transform x) => x.localRotation, "localRotation");
            MemberInfo rotationConverted = Strong.PropertyInfo(
                (TransformPropertyConverter x) => x.LocalEuler, "LocalEulerAngles");
            MemberInfo scale = Strong.PropertyInfo(
                (Transform x) => x.localScale, "localScale");
            MemberInfo scaleConverted = Strong.PropertyInfo(
                (TransformPropertyConverter x) => x.LocalScale, "LocalScale");

            return new[]
            {
                new PropertyDescriptor("Position", converters, positionConverted, position),
                new PropertyDescriptor("Rotation", converters, rotationConverted, rotation),
                new PropertyDescriptor("Scale", converters, scaleConverted, scale)
            };
        }
    }
}

Note

TransformPropertyConverter is used to convert a quaternion to Euler angles, enabling the use of Vector3Editor instead of QuaternionEditor.

Note

The remaining built-in component descriptors can be found in the Assets/Battlehub/RTEditor/Runtime/RTEditor/Editors/ComponentDescriptors folder.

Note

To save a new component, you should create a Surrogate class for it. See the Serializer Extensions section for details.

Customizing Component Editor Header

To customize the header of a component editor, you may want to override the GetHeaderDescriptor method. This allows you to specify various aspects of the header, such as its display name, the visibility of certain buttons, and whether to show an icon.

Here is an example of how to override the GetHeaderDescriptor method in a component descriptor:

public class MyComponentDescriptor : ComponentDescriptorBase<MyComponent>
{
    public override HeaderDescriptor GetHeaderDescriptor(IRTE editor)
    {
        // Customize the header descriptor as needed
        return new HeaderDescriptor(
            displayName: "My Custom Component",
            showExpander: true,
            showResetButton: true,
            showEnableButton: true,
            showRemoveButton: true,
            showIcon: true,
            icon: null
        );
    }
}

HeaderDescriptor Structure

The HeaderDescriptor struct allows you to configure the appearance and functionality of the component editor's header. It has the following properties:

Localization

To localize your application, follow these steps to create and load string resources.

  1. Create a file named My.StringResources.en-US.xml with the following format and place it in the Resources folder:
<?xml version="1.0" encoding="utf-8"?>
<StringResources xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <Resources>
        <!-- Example String Resource -->
        <StringResource id="ID_String" value="Localized String"/>
    </Resources>
</StringResources>
  1. Load the string resources using the following code:
ILocalization lc = IOC.Resolve<ILocalization>();
lc.LoadStringResources("My.StringResources");
  1. Retrieve localized strings using the GetString method:
var localizedString = lc.GetString("ID_String");

Built-in String Resources

Runtime Editor includes the following built-in string resources:

Note

Locale can be changed using following code lc.Locale = "en-US"; This will work provided that string resources files with the corresponding prefix exist.

UI Controls

Dock Panel Control

https://rteditor.battlehub.net/v350/manual/dock-panels.html

Tree View Control

https://rteditor.battlehub.net/v350/manual/vtv.html

https://rteditor.battlehub.net/v350/manual/menu-control.html

Runtime Transform Handles

Runtime Transform Handles are the runtime 3D controls used to manipulate items in the scene. There are three built-in transform tools to position, rotate, and scale objects via the transform component. Another special built-in tool, the rect tool, allows you to move and change the scale of game objects.

Supplementary controls such as the scene gizmo and grid help to change the viewing angle and projection mode, identify selected objects, and orientate in the scene space. Other important components include:

https://rteditor.battlehub.net/v350/manual/transform-handles.html

Runtime Gizmos

Runtime Gizmos are the runtime 3D controls used to manipulate items in the scene. Unlike transform handles, gizmos do not modify the transformation of objects.
Instead, they are used to modify colliders, bounding boxes, and properties of light and audio sources.

https://rteditor.battlehub.net/v350/manual/gizmos.html

Animation Editor

https://rteditor.battlehub.net/v350/manual/animation-editor.html

Runtime Editor Extensions

https://rteditor.battlehub.net/v350/manual/editor-extensions.html

Asset Database

In Runtime Editor 4.0.0, the RTSL subsystem was replaced by the Runtime Asset Database.
For information on making the runtime editor compatible with projects created using previous versions, see the Compatibility Modes section.
The documentation for Runtime Save Load can be found here.
This section focuses on the new asset database and new API methods.

Core Methods and Events

Most of the new core project, scene, prefab, and asset management methods are defined in the IRuntimeEditor and IAssetDatabaseModel interfaces.

IRuntimeEditor and IAssetDatabaseModel Interfaces

IRuntimeEditor Interface

The IRuntimeEditor interface extends IRTE and IAssetDatabaseModel to provide a comprehensive set of methods and properties for managing projects, scenes, and assets in the Runtime Editor. Key functionalities include:

IAssetDatabaseModel Interface

The IAssetDatabaseModel interface provides methods and events for managing assets within the runtime editor. It includes:

Key Methods and Properties

IRuntimeEditor

Task<ProjectListEntry[]> GetProjectsAsync();
Task<ProjectListEntry> CreateProjectAsync(string projectPath);
Task<ProjectListEntry> DeleteProjectAsync(string projectPath);
void NewScene(bool confirm = true);
void SaveScene();
void SaveSceneAs();
Task SaveCurrentSceneAsync(ID folderID, string name);
Task SaveCurrentSceneAsync(string path = null);
Task CreateAssetAsync(byte[] binaryData, string path, bool forceOverwrite = false, bool select = true);
Task CreateAssetAsync(string text, string path, bool forceOverwrite = false, bool select = true);
Task CreateAssetAsync(UnityObject obj, string path = null, bool forceOverwrite = false, bool? includeDependencies = null, bool? variant = null, bool select = true);

IAssetDatabaseModel

Task LoadProjectAsync(string projectID, string version = null);
Task UnloadProjectAsync();
Task<ID> CreateFolderAsync(string path);
Task<ID> CreateAssetAsync(object obj, string path, bool variant = false, bool extractSubassets = false);
Task<ID> ImportExternalAssetAsync(ID folderID, object key, string loaderID, string desiredName);
Task<ID> ImportExternalAssetAsync(ID folderID, ID assetID, object key, string loaderID, string desiredName);
Task InitializeNewSceneAsync();
Task UnloadAllAndClearSceneAsync();
Task SaveAssetAsync(ID assetID);
Task UpdateThumbnailAsync(ID assetID);
Task MoveAssetsAsync(IReadOnlyList<ID> assetIDs, IReadOnlyList<string> toPaths);
Task DuplicateAssetsAsync(IReadOnlyList<ID> assetIDs, IReadOnlyList<string> toPaths);
Task DeleteAssetsAsync(IReadOnlyList<ID> assetIDs);
Task SelectPrefabAsync(GameObject instance);
Task OpenPrefabAsync(GameObject instance);
Task ClosePrefabAsync();
Task OpenAssetAsync(ID assetID);
Task<InstantiateAssetsResult> InstantiateAssetsAsync(ID[] assetIDs, Transform parent = null);
Task DetachAsync(GameObject[] instances, bool completely);
Task SetDirtyAsync(Component component);
Task DuplicateAsync(GameObject[] instances);
Task ReleaseAsync(GameObject[] instances);
Task ApplyChangesAsync(GameObject instance);
Task ApplyToBaseAsync(GameObject instance);
Task RevertToBaseAsync(GameObject instance);
Task<byte[]> SerializeAsync(object asset);
Task<object> DeserializeAsync(byte[] data, object target = null);
Task<T> GetValueAsync<T>(string key);
Task SetValueAsync<T>(string key, T obj);
Task DeleteValueAsync<T>(string key);

IAssetDatabaseModel vs IRuntimeEditor Interface

var assetDatabase = IOC.Resolve<IAssetDatabaseModel>();
var runtimeEditor = IOC.Resolve<IRuntimeEditor>();

These two interfaces can be used almost interchangeably.

IAssetDatabaseModel has fewer methods, but it might be a good idea to use it if you want some parts of your code to run without opening the runtime editor.

Apart from the runtime editor itself, there are two implementations of the IAssetDatabaseModel interface: AssetDatabaseModel and AssetDatabaseModelOverRTSL (which exists for compatibility with projects created using the Runtime Save Load subsystem in previous runtime editor versions).

Projects Root Folder Path

You can set the projects root folder in two ways:

  1. By updating the Project Root Folder Path field of the Runtime Editor (script) (see RuntimeEditor.prefab/Runtime Editor (Script)/Extra Settings/Projects Root Folder Path).

  2. Programmatically:

using Battlehub.RTEditor;
using Battlehub.RTCommon;

public class SetRootFolderExt : EditorExtension
{
    protected override void OnInit()
    {
        var editor = IOC.Resolve<IRuntimeEditor>();
        editor.ProjectsRootFolderPath = @"C:\Runtime Editor Projects";
    }
}

Manage Projects

The following example demonstrates how to create, open, close, and delete projects using the Runtime Editor.

The projects are stored in Application.persistentDataPath folder
Persistent Data Path

A typical project folder looks like this:
Asset Database Project Folder

using Battlehub.RTCommon;
using Battlehub.UIControls.MenuControl;
using System;
using UnityEngine;

namespace Battlehub.RTEditor.Examples.Scene31
{
    /// <summary>
    /// Example on how to create, open, close, and delete projects.
    /// </summary>
    [MenuDefinition]
    public class ProjectManagementExampleMenu : EditorExtension
    {
        private IWindowManager m_wm;
        private IRuntimeEditor m_editor;

        protected override void OnInit()
        {
            base.OnInit();

            m_wm = IOC.Resolve<IWindowManager>();
            m_editor = IOC.Resolve<IRuntimeEditor>();
            m_editor.BeforeLoadProject += OnBeforeLoadProject;
            m_editor.LoadProject += OnLoadProject;
            m_editor.BeforeUnloadProject += OnBeforeUnloadProject;
            m_editor.UnloadProject += OnUnloadProject;
        }

        protected override void OnCleanup()
        {
            base.OnCleanup();
            m_editor.BeforeLoadProject -= OnBeforeLoadProject;
            m_editor.LoadProject -= OnLoadProject;
            m_editor.BeforeUnloadProject -= OnBeforeUnloadProject;
            m_editor.UnloadProject -= OnUnloadProject;
            m_editor = null;
            m_wm = null;
        }

        [MenuCommand("Example/Manage Projects")]
        public void ManageProjects()
        {
            m_wm.CreateWindow(BuiltInWindowNames.OpenProject);
        }

        [MenuCommand("Example/Create Project")]
        public void CreateProject()
        {
            m_wm.Prompt("Enter Project Name", "My Project", async (sender, args) =>
            {
                using var b = m_editor.SetBusy();
                await m_editor.CreateProjectAsync(args.Text);
            });
        }

        [MenuCommand("Example/Load Project")]
        public void OpenProject()
        {
            m_wm.Prompt("Enter Project Name", "My Project", async (sender, args) =>
            {
                using var b = m_editor.SetBusy();
                if (m_editor.IsProjectLoaded)
                {
                    await m_editor.UnloadProjectAsync();
                }
                await m_editor.LoadProjectAsync(args.Text);
            });
        }

        [MenuCommand("Example/Delete Project")]
        public void DeleteProject()
        {
            m_wm.Prompt("Enter Project Name", "My Project", async (sender, args) =>
            {
                using var b = m_editor.SetBusy();
                await m_editor.DeleteProjectAsync(args.Text);
            });
        }

        [MenuCommand("Example/Close Project")]
        public async void CloseProject()
        {
            using var b = m_editor.SetBusy();
            await m_editor.UnloadProjectAsync();
        }

        private void OnBeforeLoadProject(object sender, EventArgs e)
        {
            Debug.Log($"On Before Load {m_editor.ProjectID}");
        }

        private void OnLoadProject(object sender, EventArgs e)
        {
            Debug.Log($"On Load {m_editor.ProjectID}");
        }

        private void OnBeforeUnloadProject(object sender, EventArgs e)
        {
            Debug.Log($"On Before Unload {m_editor.ProjectID}");
        }

        private void OnUnloadProject(object sender, EventArgs e)
        {
            Debug.Log($"On Unload {m_editor.ProjectID}");
        }
    }
}

Manage Projects
Manage Projects

Create Folder

The following example demonstrates how to create folders using the IRuntimeEditor interface in the Runtime Editor. 

using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.RTEditor.Models;
using Battlehub.UIControls.MenuControl;
using UnityEngine;

[MenuDefinition]
public class CreateFolderExample : EditorExtension
{
    private IRuntimeEditor m_editor;

    protected override void OnInit()
    {
        base.OnInit();

        m_editor = IOC.Resolve<IRuntimeEditor>();
        m_editor.CreateFolder += OnCreateFolder;
    }

    protected override void OnCleanup()
    {
        base.OnCleanup();
        m_editor.CreateFolder -= OnCreateFolder;
    }

    [MenuCommand("Example/Create Folder")]
    public void CreateFolder()
    {
        var wm = IOC.Resolve<IWindowManager>();
        wm.Prompt("Enter Folder Name", "New Folder", async (sender, args) =>
        {
            string newFolderName = args.Text;
            if (!m_editor.IsValidName(newFolderName))
            {
                wm.MessageBox("Error", "Folder Name is invalid");
                return;
            }

            // Use the current folder as a parent
            var parentFolderID = m_editor.CurrentFolderID;

            // Make sure that the folder path is unique
            string path = m_editor.GetUniquePath(parentFolderID, newFolderName);

            // Show busy indicator
            using var b = m_editor.SetBusy();

            await m_editor.CreateFolderAsync(path);
        });
    }

    private void OnCreateFolder(object sender, CreateFolderEventArgs e)
    {
        // A folder is a special kind of asset and has an AssetID just like real assets
        // The folder asset ID is temporary and it is different between sessions
        ID assetID = e.AssetID; 

        // You can get the folder path by its ID
        var path = m_editor.GetPath(assetID);

        Debug.Log($"On Create Folder: {path}");
    }
}

Set Current Folder

The current folder is the folder selected in the project tree, whose contents are displayed in the right section of the asset database window.

using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.RTEditor.Models;
using Battlehub.UIControls.MenuControl;

[MenuDefinition]
public class SetCurrentFolderExample : EditorExtension
{
    private IRuntimeEditor m_editor;

    protected override void OnInit()
    {
        base.OnInit();

        m_editor = IOC.Resolve<IRuntimeEditor>();
        m_editor.LoadProject += OnLoadProject;
    }

    protected override void OnCleanup()
    {
        base.OnCleanup();
        m_editor.LoadProject -= OnLoadProject;
    }

    private async void OnLoadProject(object sender, System.EventArgs e)
    {
        using var b = m_editor.SetBusy();

        var path = $"{m_editor.GetRootFolderPath()}/New Folder";

        if (!m_editor.Exists(path))
        {
            await m_editor.CreateFolderAsync(path);
        }

        m_editor.CurrentFolderID = m_editor.GetAssetID(path);
    }
}

Runtime Scene

HierarchyRoot

In the current version, the runtime editor requires that all runtime scene objects must be added to the Scene game object (the hierarchy root), which has the "Respawn" tag.
This ensures that the objects are visible in the hierarchy and can be saved as part of the scene.

The exact value of the tag is specified by the ExposeToEditor.HierarchyRootTag field:

public class ExposeToEditor : MonoBehaviour
{
    public static string HierarchyRootTag = "Respawn";
}

To add a game object to the runtime editor scene programmatically, use the AddGameObjectToScene method:

var editor = IOC.Resolve<IRuntimeEditor>();

// Create a game object
var capsule = GameObject.CreatePrimitive(PrimitiveType.Capsule);

// Add the game object to the scene
editor.AddGameObjectToScene(capsule);

Create New, Save, Load scene

Here is an example of how to create, save, and open a scene in the Runtime Editor

using Battlehub.RTCommon;
using Battlehub.RTEditor.Models;
using Battlehub.UIControls.MenuControl;
using UnityEngine;

namespace Battlehub.RTEditor.Examples.Scene31
{
    [MenuDefinition]
    public class SceneExampleMenu : EditorExtension
    {
        private IRuntimeEditor m_editor;
        private IWindowManager m_wm;

        protected override void OnInit()
        {
            base.OnInit();

            m_editor = IOC.Resolve<IRuntimeEditor>();
            m_editor.InitializeNewScene += OnInitializeNewScene;
            m_editor.BeforeSaveCurrentScene += OnBeforeSaveCurrentScene;
            m_editor.SaveCurrentScene += OnSaveCurrentScene;
            m_editor.BeforeOpenScene += OnBeforeOpenScene;
            m_editor.OpenScene += OnOpenScene;
            m_wm = IOC.Resolve<IWindowManager>();
        }      

        protected override void OnCleanup()
        {
            base.OnCleanup();

            m_editor.InitializeNewScene -= OnInitializeNewScene;
            m_editor.BeforeSaveCurrentScene -= OnBeforeSaveCurrentScene;
            m_editor.SaveCurrentScene -= OnSaveCurrentScene;
            m_editor.BeforeOpenScene -= OnBeforeOpenScene;
            m_editor.OpenScene -= OnOpenScene;
            m_editor = null;
            m_wm = null;
        }


        [MenuCommand("Example/New Scene")]
        public async void InitializeNewScene()
        {
            using var b = m_editor.SetBusy();

            if (m_editor.CanInitializeNewScene)
            {
                await m_editor.InitializeNewSceneAsync();
            }
            else
            {
                m_wm.MessageBox("Error", "Can't initialize new scene");
            }
        }

        private void OnInitializeNewScene(object sender, System.EventArgs e)
        {
            Debug.Log($"On Create New Scene {m_editor.CurrentScene.name} (ID: {m_editor.CurrentSceneID})");
        }

        private string GetScenePath(PromptDialogArgs args)
        {
            string currentFolderPath = m_editor.GetCurrentFolderPath();
            string sceneExt = m_editor.GetSceneExt();
            string scenePath = $"{currentFolderPath}/{args.Text}{sceneExt}";
            return scenePath;
        }

        [MenuCommand("Example/Save Scene")]
        public void SaveCurrentScene()
        {
            m_wm.Prompt("Enter Scene Name", "My Scene", async (sender, args) =>
            {
                using var b = m_editor.SetBusy();

                if (m_editor.CanSaveScene)
                {
                    string scenePath = GetScenePath(args);

                    await m_editor.SaveCurrentSceneAsync(scenePath);
                }
                else
                {
                    m_wm.MessageBox("Error", "Can't save current scene");
                }
            });
        }

        private void OnBeforeSaveCurrentScene(object sender, BeforeSaveSceneEventArgs e)
        {
            Debug.Log($"On Before Save Current Scene");
        }

        private void OnSaveCurrentScene(object sender, SaveSceneEventArgs e)
        {
            Debug.Log($"On Save Current Scene: {e.Scene.name} (ID: {e.SceneID} Path: {e.ScenePath})");
        }

        [MenuCommand("Example/Open Scene")]
        public void OpenScene()
        {
            m_wm.Prompt("Enter Scene Name", "My Scene", async (sender, args) =>
            {
                using var b = m_editor.SetBusy();

                string scenePath = GetScenePath(args);

                if (m_editor.Exists(scenePath))
                {
                    await m_editor.OpenSceneAsync(scenePath);
                }
                else
                {
                    m_wm.MessageBox("Error", $"Scene {scenePath} does not exist");
                }
            });
        }

        private void OnBeforeOpenScene(object sender, AssetEventArgs e)
        {
            Debug.Log($"On Before Open Scene (ID: {e.AssetID})");
        }

        private void OnOpenScene(object sender, AssetEventArgs e)
        {
            Debug.Log($"On Open Scene (ID: {e.AssetID})");
        }
    }
}

Create, Save, Load, Delete Assets and Folders

This is example on how to create, save, load, delete assets and folders

using Battlehub.RTCommon;
using Battlehub.RTEditor.Models;
using Battlehub.UIControls.MenuControl;
using System.Linq;
using UnityEngine;

namespace Battlehub.RTEditor.Examples.Scene32
{

    [MenuDefinition]
    public class FolderAndAssetExampleMenu : EditorExtension
    {
        private IRuntimeEditor m_editor;
        private IWindowManager m_wm;

        protected override void OnInit()
        {
            m_editor = IOC.Resolve<IRuntimeEditor>();
            m_editor.CreateFolder += OnCreateFolder;
            m_editor.CreateAsset += OnCreateAsset;
            m_editor.SaveAsset += OnSaveAsset;
            m_editor.DeleteAssets += OnDeleteAssets;
            m_wm = IOC.Resolve<IWindowManager>();
        }

        protected override void OnCleanup()
        {
            m_editor.CreateFolder -= OnCreateFolder;
            m_editor.CreateAsset -= OnCreateAsset;
            m_editor.SaveAsset -= OnSaveAsset;
            m_editor.DeleteAssets -= OnDeleteAssets;
            m_editor = null;
            m_wm = null;
        }

        private string GetPath(string name, string ext = null)
        {
            string currentFolderPath = m_editor.GetCurrentFolderPath();
            return $"{currentFolderPath}/{name}{ext}";
        }

        [MenuCommand("Example/Create Folder")]
        public void CreateFolder()
        {
            m_wm.Prompt("Enter Folder Name", "My Folder", async (sender, args) =>
            {
                string path = GetPath(args.Text);

                if (!m_editor.Exists(path))
                {
                    using var b = m_editor.SetBusy();

                    await m_editor.CreateFolderAsync(path);
                }
            });
        }

        [MenuCommand("Example/Delete Folder")]
        public void DeleteFolder()
        {
            m_wm.Prompt("Enter Folder Name", "My Folder", async (sender, args) =>
            {
                string path = GetPath(args.Text);

                if (m_editor.Exists(path))
                {
                    using var b = m_editor.SetBusy();

                    await m_editor.DeleteAssetAsync(path);
                }
                else
                {
                    m_wm.MessageBox("Error", 
                        $"A folder named '{args.Text}' is not in the current folder");
                }
            });
        }

        [MenuCommand("Example/Delete Current Folder", validate: true)]
        public bool CanDeleteCurrentFolder()
        {
            return m_editor.CurrentFolderID != m_editor.RootFolderID;
        }

        [MenuCommand("Example/Delete Current Folder")]
        public async void DeleteCurrentFolder()
        {
            using var b = m_editor.SetBusy();

            var currentFolderID = m_editor.CurrentFolderID;
            await m_editor.DeleteAssetAsync(currentFolderID);
        }

        [MenuCommand("Example/Create Prefab", validate: true)]
        public bool CanCreatePrefab()
        {
            var go = m_editor.Selection.activeGameObject;
            return m_editor.CanCreatePrefab(go);
        }

        [MenuCommand("Example/Create Prefab")]
        public async void CreatePrefab()
        {
            using var b = m_editor.SetBusy();

            var go = m_editor.Selection.activeGameObject;
            await m_editor.CreateAssetAsync(go);
        }

        [MenuCommand("Example/Create Material")]
        public async void CreateMaterial()
        { 
            var material = Instantiate(RenderPipelineInfo.DefaultMaterial);
            material.name = "Material";
            material.Color(Color.green);
            material.MainTexture(Resources.Load<Texture2D>("Duck"));

            using var b = m_editor.SetBusy();
            await m_editor.CreateAssetAsync(material);
        }


        [MenuCommand("Example/Update Material", validate: true)]
        public bool CanUpdateMaterial()
        {
            return m_editor.Selection.activeObject is Material;
        }

        [MenuCommand("Example/Update Material")]
        public async void UpdateMaterial()
        {
            Material material = (Material)m_editor.Selection.activeObject;
            material.Color(Random.ColorHSV());

            ID assetID = m_editor.GetAssetID(material); 
            if (assetID != ID.Empty)
            {
                using var b = m_editor.SetBusy();
                await m_editor.SaveAssetAsync(assetID);
            }
        }

        [MenuCommand("Example/Delete Selected", validate: true)]
        public bool CanDeleteSelected()
        {
            return m_editor.SelectedAssets.Length > 0 &&
                !m_editor.SelectedAssets.Contains(m_editor.RootFolderID);
        }

        [MenuCommand("Example/Delete Selected")]
        public async void DeleteSelected()
        {
            using var b = m_editor.SetBusy();
            var selection = m_editor.SelectedAssets;
            await m_editor.DeleteAssetsAsync(selection);
        }

        private void OnCreateFolder(object sender, CreateFolderEventArgs e)
        {
            Debug.Log(
                $"On Create Folder (ID: {e.AssetID} Path: {m_editor.GetPath(e.AssetID)})");
        }

        private void OnCreateAsset(object sender, CreateAssetEventArgs e)
        {
            Debug.Log(
                $"On Create Asset (ID: {e.AssetID} Path: {m_editor.GetPath(e.AssetID)})");
        }

        private void OnSaveAsset(object sender, SaveAssetEventArgs e)
        {
            Debug.Log(
                $"On Save Asset (ID: {e.AssetID} Path: {m_editor.GetPath(e.AssetID)})");
        }

        private void OnDeleteAssets(object sender, DeleteAssetsEventArgs e)
        {
            for (int i = 0; i < e.AssetID.Count; ++i)
            {
                ID assetID = e.AssetID[i];
                Debug.Log(
                    $"On Delete Asset (ID: {assetID}, Children: {e.ChildrenID[i].Count})");
            }   
        }
    }
}

Instantiate asset

This is an example of creating and instantiating an asset.

using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.UIControls.MenuControl;
using System.Linq;
using UnityEngine;

[MenuDefinition]
public class InstantiateAssetExample : MonoBehaviour
{
    [MenuCommand("Example/Create Asset")]
    public async void Create()
    {
        var editor = IOC.Resolve<IRuntimeEditor>();

        // Create game object
        var capsule = GameObject.CreatePrimitive(PrimitiveType.Capsule);
        editor.AddGameObjectToScene(capsule, select:false);

        // Expose to editor
        capsule.AddComponent<ExposeToEditor>();

        // Get .prefab extension
        var ext = editor.GetExt(capsule);

        // Get unique asset path
        var path = editor.GetUniquePath($"Capsule{ext}");

        // Create asset
        await editor.CreateAssetAsync(capsule, path);

        // Select create asset
        editor.SelectedAssets = new[] { editor.GetAssetID(path) };
    }

    [MenuCommand("Example/Instantiate Asset", validate:true)]
    public bool CanInstanate()
    {
        var editor = IOC.Resolve<IRuntimeEditor>();
        return editor.SelectedAssets.Any(asset => editor.CanInstantiateAsset(asset));
    }


    [MenuCommand("Example/Instantiate Asset")]
    public  async void Instanate()
    {
        var editor = IOC.Resolve<IRuntimeEditor>();
        using var b = editor.SetBusy();

        // Instantiate selected assets
        var result = await editor.InstantiateAssetsAsync(editor.SelectedAssets);

        // Select instances
        editor.Selection.objects = result.Instances;
    }
}

Instanate Asset

Duplicate Asset

You can duplicate any asset or folder you select in the project view.

using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.RTEditor.Models;
using Battlehub.UIControls.MenuControl;
using UnityEngine;

[MenuDefinition]
public class DuplicateAssetExample : MonoBehaviour
{
    [MenuCommand("Example/Duplicate Asset", validate:true)]
    public bool CanDuplicate()
    {
        var editor = IOC.Resolve<IRuntimeEditor>();
        return editor.SelectedAssets.Length > 0 &&
            editor.CanDuplicateAsset(editor.SelectedAssets[0]);
    }


    [MenuCommand("Example/Duplicate Asset")]
    public async void Dupicate()
    {
        var editor = IOC.Resolve<IRuntimeEditor>();

        var assetID = editor.SelectedAssets[0];
        string path = editor.GetPath(assetID);
        string targetPath = editor.GetUniquePath(path);

        using var b = editor.SetBusy();
        await editor.DuplicateAssetAsync(assetID, targetPath);
    }
}

Move Asset

This example shows how to move an asset. You can rename assets using the same approach.

using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.RTEditor.Models;
using Battlehub.UIControls.MenuControl;
using UnityEngine;

[MenuDefinition]
public class MoveAssetExample : MonoBehaviour
{
    [MenuCommand("Example/Move Asset", validate: true)]
    public bool CanMoveAsset()
    {
        var editor = IOC.Resolve<IRuntimeEditor>();
        return editor.SelectedAssets.Length > 0;
    }


    [MenuCommand("Example/Move Asset")]
    public async void MoveAsset()
    {
        var editor = IOC.Resolve<IRuntimeEditor>();

        var assetID = editor.SelectedAssets[0];
        string path = editor.GetPath(assetID);
        string targetPath = editor.GetUniquePath(path);

        using var b = editor.SetBusy();
        await editor.MoveAssetAsync(editor.SelectedAssets[0], targetPath);
    }
}

External Asset Loaders

External asset loaders are used to load external assets imported into a project.
An external asset is an asset loaded into the project using a specific loader, such as the Addressable Loader, a loader that loads assets from the Resources folder, a GLB loader, or any other third-party loader.
External assets are read-only and contain only identifiers for parts within the data file. If you need to make edits to an external asset, you can create an asset variant of it.

There are four built-in external asset loaders:

Important: You must install com.unity.addressables to use this loader. For more information, refer to the Unity Addressables documentation.

Important: You must install com.unity.cloud.gltfast to use this loader. For more information, refer to the GLTFast documentation.

To create your own loader, implement the IExternalAssetLoaderModel interface:

using Battlehub.RTEditor.Models;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using UnityEngine;

using UnityObject = UnityEngine.Object;
public class MyLoader : IExternalAssetLoaderModel
{
    public string LoaderID => nameof(MyLoader);

    public Task<object> LoadAsync(string key, object root, IProgress<float> progress = null)
    {
        var parent = root as Transform;

        GameObject asset;
        switch(key)
        {
            case "Cube":
                asset = GameObject.CreatePrimitive(PrimitiveType.Cube);
                break;
            case "Capsule":
                asset = GameObject.CreatePrimitive(PrimitiveType.Capsule);
                break;
            default:
                throw new KeyNotFoundException(key);
        }

        asset.transform.SetParent(parent, false);

        return Task.FromResult<object>(asset);
    }

    public void Release(object obj)
    {
        var asset = obj as UnityObject;
        if (asset != null)
        {
            UnityObject.Destroy(asset);
        }
    }
}

To register your custom loader, use the AddExternalAssetLoader method:

hljs using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.RTEditor.Models;

public class RegisterMyLoader : EditorExtension
{
    private IRuntimeEditor m_editor;
    private IExternalAssetLoaderModel m_loader;

    protected override void OnInit()
    {
        m_editor = IOC.Resolve<IRuntimeEditor>();

        m_loader = new MyLoader();

        m_editor.AddExternalAssetLoader(m_loader);
    }

    protected override void OnCleanup()
    {
        m_editor.RemoveExternalAssetLoader(m_loader);
        m_editor = null;
    }
}

After registering the custom loader, you can use the ImportExternalAssetAsync method to import an external asset by providing the loader ID and key to the method:

hljs using var b = m_editor.SetBusy();
await m_editor.ImportExternalAssetAsync(m_editor.RootFolderID, key: "Cube", loaderID: nameof(MyLoader), desiredName: "My External Asset");

Custom External Asset Loader

Note

For the Resources Loader, you should use the relative path in the Resources folder as the key (this is the same as the path parameter in the Resources.Load method).

For the Addressables Loader, the key will be used as a parameter for the Addressables.LoadAsset method.

For the GLTFastLoader Loader, the key can be an absolute URI, an absolute path, or a path relative to the .Library folder inside the runtime project folder.

Here is the refined documentation with improved grammar and clarity:

TriLibLoader Example

The Runtime Editor is only able to load .glb and .gltf models. For .fbx and other formats, you need to use an asset such as TriLib. Here is an example of how to create an external asset loader using the TriLib library and integrate it with the Runtime Editor. The procedure is almost the same as for any other loader.

Implement IExternalAssetLoaderModel

using Battlehub.RTCommon;
using Battlehub.RTEditor.Models;
using System;
using System.IO;
using System.Threading.Tasks;
using TriLibCore;
using UnityEngine;

public class TriLibLoaderModel : IExternalAssetLoaderModel
{
    public string LoaderID => nameof(TriLibLoaderModel);

    public string LibraryFolder { get; set; }

    private Task<GameObject> LoadUsingTriLibAsync(string filePath, Transform root)
    {
        TaskCompletionSource<GameObject> tcs = new TaskCompletionSource<GameObject>();
        GameObject go = null;
        var options = AssetLoader.CreateDefaultLoaderOptions();
        options.AddAssetUnloader = false;

        AssetLoader.LoadModelFromFile(filePath, ctx =>
        {
            go = ctx.RootGameObject;
            go.transform.SetParent(root);
        },
        ctx =>
        {
            tcs.SetResult(go);
        },
        (ctx, progress) => { },
        err =>
        {
            tcs.SetException(err.GetInnerException());
        }, 
        null, options);

        return tcs.Task;
    }

    public async Task<object> LoadAsync(string key, object root, IProgress<float> progress = null)
    {
        string path;
        if (Uri.TryCreate(key, UriKind.Absolute, out _) || Path.IsPathRooted(key))
        {
            path = key;
        }
        else
        {
            path = !string.IsNullOrEmpty(LibraryFolder) ? $"{LibraryFolder}/{key}" : key;
        }

        var go = await LoadUsingTriLibAsync(path, root as Transform);
        var parts = go.GetComponentsInChildren<Transform>(true);
        foreach (var part in parts)
        {
            part.gameObject.AddComponent<ExposeToEditor>();
        }

        return go;
    }

    public void Release(object obj)
    {
        GameObject go = obj as GameObject;
        if (go != null)
        {
            UnityEngine.Object.Destroy(go);
        }
    }
}

Register TriLibLoader

using Battlehub.RTCommon;
using Battlehub.RTEditor;
using Battlehub.RTEditor.Models;

public class RegisterTriLibLoader : EditorExtension
{
    private IRuntimeEditor m_editor;
    private IExternalAssetLoaderModel m_loader;

    protected override void OnInit()
    {
        m_editor = IOC.Resolve<IRuntimeEditor>();
        m_loader = new TriLibLoaderModel();
        m_editor.AddExternalAssetLoader(m_loader);
    }

    protected override void OnCleanup()
    {
        m_editor.RemoveExternalAssetLoader(m_loader);
        m_editor = null;
    }
}

Import FBX as External Asset

using var b = m_editor.SetBusy();

string key = "F:/ModelsCollection/ikea desk.fbx";
string loaderID = nameof(TriLibLoaderModel);
string name = "My Model";

await m_editor.ImportExternalAssetAsync(m_editor.RootFolderID, key, loaderID, name);

TriLib Asset Loader

Import Sources

If you want to allow the user to select which assets to import and import them themselves, you should create import sources.

There are three built-in import sources:

In the Runtime Editor, if you click File > Import Assets, the asset database import source window will open, and you will see a dropdown with all available import sources.

  1. Select an import source from the dropdown.
  2. The list of asset groups will be loaded (by default, there is only one Default group in all built-in sources).
  3. Select a group and click OK.
  4. You will be navigated to the asset database import view.
  5. Select assets and click Import.

The IRuntimeEditor.ImportExternalAssetAsync method will be called for each of the selected assets with the corresponding key and loader ID.

Open Import Sources window
Select Import Source
Select Import Group
Select Import Assets
Import Assets

Resources Import Source

To access built-in import sources and modify groups and assets, follow these steps:

  1. Create Asset Database
  1. Collect Scene Assets (Optional)
  1. Add Assets or Groups

Note

It is possible to do the same programmatically. The ResourcesImportSourceModel has two public methods:

void ResourcesImportSourceModel.SetGroups(ImportGroup[] groups)
void ResourcesImportSourceModel.SetAssets(ImportAsset[] assets)

The ImportGroup and ImportAsset classes are used to define the groups and assets to be imported.

Addressables Import Source

  1. Install the Addressables Package
  1. Create Addressables Settings
  1. Make Prefabs Addressable
  1. Create a New Build (Optional)
  1. Configure AssetDatabaseModel

Custom Import Source

To create your own import source, follow these steps:

  1. Implement the IImportSourceModel Interface

    using Battlehub.RTEditor.Models;
using System.Threading.Tasks;

public class MyImportSource : IImportSourceModel
{
    public bool IsEnabled => true;<pre><code>public int SortIndex => 0;

public string DisplayName => "My Import Source";

public string LoaderID => nameof(MyLoader);

public Task<IImportGroup[]> GetGroupsAsync()
{
    IImportGroup[] groups = new[]
    {
        new ImportGroup(
            key: "DefaultGroupKey",
            name: "My Group")
    };
    return Task.FromResult(groups);
}

public Task<IImportAsset[]> GetAssetsAsync(string groupKey)
{
    var assets = new[]
    {
        new ImportAsset("DefaultGroupKey", "Cube", "My Cube"),
        new ImportAsset("DefaultGroupKey", "Capsule", "My Capsule"),
    };

    return Task.FromResult<IImportAsset[]>(assets);
}
</code></pre>}

  2. Register the Custom Import Source

    using Battlehub.RTCommon;
using Battlehub.RTEditor;

public class RegisterMyImportSource : EditorExtension
{
    private IRuntimeEditor m_editor;
    private MyImportSource m_importSource;<pre><code>protected override void OnInit()
{ 
    m_importSource = new MyImportSource();
    m_editor = IOC.Resolve<IRuntimeEditor>();
    m_editor.AddImportSource(m_importSource);
}

protected override void OnCleanup()
{
    m_editor.RemoveImportSource(m_importSource);
    m_importSource = null;
    m_editor = null;
}
</code></pre>}

  3. Use the Custom Import Source

    Once registered, your custom import source will be available in the Runtime Editor's asset import dropdown. Users can select it and import assets as configured.

    Custom Import Source
    Custom Import Source

Note

In this example, MyLoader from External Asset Loaders is being used. Ensure you have implemented and registered MyLoader as described in the previous sections.

File Importers

File importers come into play when you open the file picker using File -> Import From File in the Runtime Editor menu.

Open File Picker
File Picker

The file picker determines which types of files to show by inspecting the supported extensions of available file importers.

There are four built-in file importers:

Note
To enable GlbImporter and GltfImporter, you should install com.unity.cloud.gltfast. For more information, refer to the GLTFast documentation.

Custom File Importer

To create a custom file importer, you need to create a class derived from AssetDatabaseFileImporter.
Override the FileExt field to return the supported file extension and implement the ImportAsync method.

In the example below, the TriLibLoader from the TriLib Loader Example is used to load an external asset.
Imported models are cached in the .Library folder.

Note
You don't have to use loaders in the import method; you can simply use the IRuntimeEditor.CreateAsset method to create a normal asset, not an external one.

using Battlehub.RTEditor;
using Battlehub.RTEditor.Models;
using System;
using System.Threading;
using System.Threading.Tasks;

public class FbxFileImporter : AssetDatabaseFileImporter
{
    public override int Priority
    {
        get { return int.MinValue; }
    }

    public override string FileExt
    {
        get { return ".fbx"; }
    }

    public override string IconPath
    {
        get { return "Importers/Fbx"; }
    }

    public override async Task ImportAsync(string filePath, string targetPath, CancellationToken cancelToken)
    {
        try
        {
            Guid assetID = Guid.NewGuid();
            string externalAssetKey = AddFileToLibrary(filePath, assetID);
            await ImportExternalAsset(targetPath, assetID, externalAssetKey, m_assetLoader);
        }
        catch (Exception e)
        {
            throw new FileImporterException(e.Message, e);
        }
    }

    private IExternalAssetLoaderModel m_assetLoader;
    public override void Load()
    {
        base.Load();

        var triLibLoader = new TriLibLoaderModel
        {
            LibraryFolder = Editor.LibraryRootFolder
        };
        m_assetLoader = triLibLoader;

        Editor.AddExternalAssetLoader(m_assetLoader.LoaderID, m_assetLoader);
    }

    public override void Unload()
    {
        Editor.RemoveExternalAssetLoader(m_assetLoader.LoaderID);
        m_assetLoader = null;

        base.Unload();
    }
}

Web Storage Sample

You can use the runtime asset database in conjunction with an HTTP web server, in WebGL and Standalone builds.

To start the web sample, follow these steps:

  1. Install the Newtonsoft Json package). In Package Manager, click on "+ Add package by name" and enter "com.unity.nuget.newtonsoft-json"
  2. Unpack the Asset/Battlehub/Storage.Web Unity package.
  3. Open the Asset/Battlehub.Extensions/Storage.Web/SampleScene Unity scene.
  4. Extract Asset/Battlehub.Extensions/Storage.Web/SampleHttpServer.zip to a folder (e.g., C:\SampleHttpWebServer).
  5. Install Node.js from Node.js.
  6. Open a terminal and navigate to C:\SampleHttpWebServer.
  7. Run the command npm install.
  8. Run the command node app.js.
  9. Enter play mode in Unity.
  10. The projects will be created in the Project Root Folder Path (see SampleScene/RuntimeEditor/Runtime Editor (Script)/Extra Settings/Projects Root Folder Path).

Serializer Extensions

Surrogates are intermediary classes used by the Serializer to facilitate the reading and writing of data to Unity objects during serialization. To enable the serialization of a specific class, you must create a surrogate for it. These surrogates can be generated automatically or created from scratch. To generate a Surrogate class, you can use the "Create Surrogates" window.

Generate Surrogate

Sample component:

using UnityEngine;

public class MyComponent : MonoBehaviour
{
    public Material Material;

    public GameObject Target;

    public int IntValue;

    public string StringValue;
}

Surrogates Folder

using ProtoBuf;
using System;
using System.Threading.Tasks;

namespace Battlehub.Storage.Surrogates
{
    [ProtoContract]
    [Surrogate(typeof(global::MyComponent), _PROPERTY_INDEX, _TYPE_INDEX)]
    public class MyComponentSurrogate<TID> : ISurrogate<TID> where TID : IEquatable<TID>
    {   
        const int _PROPERTY_INDEX = 7;
        const int _TYPE_INDEX = 153;
        //_PLACEHOLDER_FOR_EXTENSIONS_DO_NOT_DELETE_OR_CHANGE_THIS_LINE_PLEASE

        [ProtoMember(2)]
        public TID id { get; set; }

        [ProtoMember(3)]
        public TID gameObjectId { get; set; }

        [ProtoMember(4))]
        public global::System.Boolean enabled { get; set; }

        [ProtoMember(5)]
        public TID Material { get; set; }

        [ProtoMember(6)]
        public TID Target { get; set; }

        [ProtoMember(7))]
        public global::System.Int32 IntValue { get; set; }
        //_PLACEHOLDER_FOR_NEW_PROPERTIES_DO_NOT_DELETE_OR_CHANGE_THIS_LINE_PLEASE

        public ValueTask Serialize(object obj, ISerializationContext<TID> ctx)
        {
            var idmap = ctx.IDMap;

            var o = (global::MyComponent)obj;
            id = idmap.GetOrCreateID(o);
            gameObjectId = idmap.GetOrCreateID(o.gameObject);
            enabled = o.enabled;
            Material = idmap.GetOrCreateID(o.Material);
            Target = idmap.GetOrCreateID(o.Target);
            IntValue = o.IntValue;
            //_PLACEHOLDER_FOR_SERIALIZE_METHOD_BODY_DO_NOT_DELETE_OR_CHANGE_THIS_LINE_PLEASE

            return default;
        }

        public ValueTask<object> Deserialize(ISerializationContext<TID> ctx)
        {
            var idmap = ctx.IDMap;

            var o = idmap.GetComponent<global::MyComponent, TID>(id, gameObjectId);
            o.enabled = enabled;
            o.Material = idmap.GetObject<global::UnityEngine.Material>(Material);
            o.Target = idmap.GetObject<global::UnityEngine.GameObject>(Target);
            o.IntValue = IntValue;
            //_PLACEHOLDER_FOR_DESERIALIZE_METHOD_BODY_DO_NOT_DELETE_OR_CHANGE_THIS_LINE_PLEASE

            return new ValueTask<object>(o);
        }
    }
}

After successfully generating surrogates, you have the flexibility to make various customizations within your surrogate class. You can remove properties that you don't want to be serialized, add new properties, or perform other operations as needed.

To prevent changes you make to surrogates from being tracked and displayed in the "Update Surrogates" window, you can set the enableUpdates attribute to false using the following syntax:

[Surrogate(typeof(global::MyComponent), _PROPERTY_INDEX, _TYPE_INDEX, enableUpdates: false)]

For value types, make sure to set enabled to false like this:

[Surrogate(typeof(global::MyComponent), _PROPERTY_INDEX, _TYPE_INDEX, enabled: false)]

Two constants, int PROPERTYINDEX and int TYPEINDEX, have following purpose:

Please note that references to other types with surrogates are replaced with their identifier (TID). You can use an "idmap" to generate unique IDs for objects and retrieve objects using their corresponding IDs.

Enumerators

The enumerator is created along with the surrogate. Enumerators are specialized classes used to retrieve Unity object dependencies in a structured manner. These enumerators enable the serialization of an entire object tree, ensuring that dependencies are deserialized before dependent objects during the deserialization process.

Enumerators Folder

namespace Battlehub.Storage.Enumerators
{
    [ObjectEnumerator(typeof(global::MyComponent))]
    public class MyComponentEnumerator : ObjectEnumerator<global::MyComponent>
    {
        public override bool MoveNext()
        {
            do
            {
                switch (Index)
                {

                    case 0:
                        if (MoveNext(TypedObject.Material, 5))
                            return true;
                        break;
                    case 1:
                        if (MoveNext(TypedObject.Target, 6))
                            return true;
                        break;
                    case 2:
                        if (MoveNext(Object, -1))
                            return true;
                        break;
                    default:
                        return false;
                }
            }
            while (true);
        }
    }
}

Note that the second parameter of the MoveNext method is the property index, which should be equal to the argument of the ProtoMember attribute assigned to that property in the surrogate class.

Build All

After finishing creating or updating surrogates, make sure to click "Tools" > "Runtime Asset Library" > "Build All" from the main menu. This command will build the type model and serializer.

Build All Menu
Type Model

Support

If you cannot find something in the documentation or have any questions, please feel free to send an email to [email protected] or ask directly in this support group. You can also create an issue here.
Keep up the great work in your development journey! 😊