Class ProjectSettingsPlugin

Constructs a project settings plugin bound to the given plugin system and optional descriptor.

Hierarchy (View Summary)

IPlugin
- ProjectSettingsPlugin

Index

Constructors

Properties

id pluginSystem

Methods

createWidget deinit getTypeName isOfType isSame setIssues

Constructors

constructor

new ProjectSettingsPlugin(
pluginSystem: PluginSystem,
descriptor?: Descriptor,
): ProjectSettingsPlugin
Initializes a ProjectSettingsPlugin with a plugin system and optional descriptor.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns ProjectSettingsPlugin
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

Reference to the plugin system instance.

Methods

createWidget

createWidget(parent: Widget): Widget
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
- parent: Widget
Returns Widget

deinit

deinit(): void
Call to shut down or unloadplugin. Used to clean up resources, listeners, or state.

Returns void

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPlugin.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPlugin.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPlugin.isSame

setIssues

setIssues(issues: (Error | Warning | NoIssue)[]): void
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
- issues: (Error | Warning | NoIssue)[]
Returns void