Plugins
Plugin types (editor, panel, dialog, project settings, URI handler, background services, presets), the plugin system and its interfaces, and plugin verification.
Commonly used
LensStudio:PanelPluginModule providing base classes for creating panel-based plugins in Lens Studio.LensStudio:CoreServiceBase class and module for creating background plugin services in Lens Studio.LensStudio:DialogPluginModule providing base classes for building dialog-style plugins in Lens Studio.LensStudio:PresetModule providing the base Preset class and Descriptor for creating editor presets that add objects, assets, or components to a Lens Studio scene.Editor.PluginSystemProvides access to the Lens Studio editor plugins, components, and interfacesEditor.IContextActionRegistryA registry of Editor.ContextAction which will be shown in a contextual menu (i.e. right click).
Guides
Building PluginsYou can build your own plugins to support your own workflow, and even share it to help others.Basic StructuresThe following examples will guide you through the essential steps of plugin creation.Plugin Development OverviewPlugins are add-ons that can be installed in Lens Studio 5.0 to extend the app’s capabilities and enhance developer workflows.
All APIs in this topic
Get editor services with this.pluginSystem.findInterface(Editor.Model.IModel) and import modules with import * as Ui from 'LensStudio:Ui'.
Components, assets, and modules
| API | Description |
|---|---|
| LensStudio:CoreService | Base class and module for creating background plugin services in Lens Studio. |
| LensStudio:DialogPlugin | Module providing base classes for building dialog-style plugins in Lens Studio. |
| LensStudio:EditorPlugin | Module providing base classes for building editor plugins that integrate custom editing behavior into Lens Studio. |
| LensStudio:GuiService | Module providing GUI service plugin infrastructure for Lens Studio. |
| LensStudio:PanelPlugin | Module providing base classes for creating panel-based plugins in Lens Studio. |
| LensStudio:PluginVerifier | Module providing base classes for writing plugin verifiers that validate plugin behavior in Lens Studio. |
| LensStudio:Preset | Module providing the base Preset class and Descriptor for creating editor presets that add objects, assets, or components to a Lens Studio scene. |
| LensStudio:ProjectSettingsPlugin | Module for registering and managing project settings panels in Lens Studio. |
| LensStudio:UriHandlerPlugin | Module providing URI handling plugin infrastructure for extending Lens Studio with custom URI scheme handlers. |
Editor services
| API | Description |
|---|---|
| Editor.IAuthorization | Component that allows you to check whether Lens Studio is authorized, as well as get authorization. |
| Editor.IContextActionRegistry | A registry of Editor.ContextAction which will be shown in a contextual menu (i.e. right click). |
| Editor.IPackageActions | Interface for package-level actions. |
| Editor.IPackageRegistry | Interface for package discovery and registration. |
Objects and data
| API | Description |
|---|---|
| BaseDescriptor | Base class for plugin descriptors containing metadata and interface requirements. |
| Editor | Namespace that provides access to the components of Lens Studio. |
| Editor.ContextAction | An action in a Editor.IContextActionRegistry. |
| Editor.IContext | Editor context passed to context action callbacks when a right-click menu is triggered. |
| Editor.IGuard | Represents ownership of a resource. |
| Editor.IInterface | Base interface type for Editor plugin system objects. |
| Editor.InterfaceId | Unique identifier for plugin interfaces. |
| Editor.IPlugin | Interface representing a plugin. |
| Editor.IPluginComponent | Interface for plugin component registration. |
| Editor.PackageMetadata | Metadata information about a package. |
| Editor.PluginSystem | Provides access to the Lens Studio editor plugins, components, and interfaces |
| IPanelPlugin | Plugin base class for plugins that contribute a titled UI panel widget to the editor. |
| IPluginDescriptor | Descriptor exposing a plugin's id, name, description, dependencies, and exported interfaces. |
Enums
| API | Description |
|---|---|
| Editor.TargetPlatform | Enum of platforms a Lens Studio plugin or project can target. |
Related topics
User InterfaceWidgets, layouts, and dialogs for plugin panels; docking, icons, entity pickers, and editor views.Project & SceneThe open project and its scene: scene objects, entities, layers, the asset manager, and import and export.AI & Chat ToolsChat tools and the chat assistant, the in-editor MCP server, and AI chat history.