Editor Scripting API
    Preparing search index...

    Class ProjectSettingsPlugin

    ProjectSettingsPlugin allows creating custom project settings panels in Lens Studio. Plugins implement this interface to add domain-specific settings (e.g., Mobile Settings, Preview Settings, Spectacles Settings) with custom UI, issue reporting, and lifecycle management.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    id pluginSystem

    Methods

    createWidget deinit getTypeName isOfType isSame setIssues

    Constructors

    Properties

    id: string
    pluginSystem: PluginSystem

    Reference to the plugin system instance.

    Methods

    • Creates and returns a UI widget for the project settings panel. The returned widget must be a child of the provided parent widget. Called by the project settings dialog to render the plugin's UI.

      Parameters

      Returns Widget

    • Call to shut down or unloadplugin. Used to clean up resources, listeners, or state.

      Returns void

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object refers to the same instance as the given object.

      Parameters

      Returns boolean

    • Sets the current issue status (errors, warnings, or no issues) for this settings panel. Triggers the issuesChanged signal when statuses change, allowing the settings dialog to update visual indicators.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods