For the complete documentation index, see llms.txt. This page is also available as Markdown.

User Interface

Runtime Studio provides several extension points for building custom editor UI at runtime. Most UI extensions can be discovered automatically, but registering them through an IEditorModule is recommended.

UI Extension Overview

API
Purpose

IEditorPanel

Create custom docked or overlay panels.

SceneToolOverlayItem

Add buttons and controls to the Scene View overlay.

SceneSettingsMenuItem

Add entries to the Scene Settings menu.

IRuntimeComponentDrawer

Draw custom inspector UI for Unity components.

IRuntimePropertyDrawer

Draw custom inspector UI for nested data types.

HierarchyAdornmentDefinition

Show icons beside hierarchy items.

IRuntimeHierarchyContextAction

Add hierarchy right-click menu actions.

FieldInspector

Draw runtime-safe fields inside custom drawers.

EditorStyles

Create UI that matches Runtime Studio's look and feel.


Panels

Panels are UI Toolkit views displayed inside the Runtime Studio editor.

Register the panel:

Panel Locations

Common Options

Scene Tool Overlay Items

Scene tool overlay items appear as buttons inside the Scene View.

Common Options

Placement

Scene Settings Menu Items

Add custom entries to the Scene Settings dropdown.

Headers:

Submenus:

Component Drawers

Component drawers control how a component appears in the inspector.

Register it:

Context Helpers


Property Drawers

Property drawers customize how nested objects are displayed.

Register it:

Hierarchy Adornments

Hierarchy adornments display small icons next to objects in the hierarchy.

Use them to highlight important objects or runtime data.

Hierarchy Context Actions

Context actions appear when right-clicking objects in the hierarchy.

Register it:

FieldInspector

FieldInspector provides the same field UI used by Runtime Studio's built-in inspector.

Draw a value:

Draw object fields:

Draw a type picker:

EditorStyles

Use EditorStyles when creating custom UI so your extension matches the rest of Runtime Studio.

Titles

Buttons

Rows

Panels

Last updated