Class ScyllaSettingsProvider

Integrates the Scylla Framework into Unity's Project Settings window (Edit > Project Settings > Scylla) as a custom settings page.

Inheritance
object
SettingsProvider
ScyllaSettingsProvider
Inherited Members
SettingsProvider.OnTitleBarGUI()
SettingsProvider.OnFooterBarGUI()
SettingsProvider.OnInspectorUpdate()
SettingsProvider.Repaint()
SettingsProvider.PopulateSearchKeywordsFromGUIContentProperties<T>()
SettingsProvider.ToString()
SettingsProvider.GetSearchKeywordsFromGUIContentProperties<T>()
SettingsProvider.GetSearchKeywordsFromSerializedObject(SerializedObject)
SettingsProvider.label
SettingsProvider.settingsPath
SettingsProvider.scope
SettingsProvider.keywords
SettingsProvider.guiHandler
SettingsProvider.titleBarGuiHandler
SettingsProvider.footerBarGuiHandler
SettingsProvider.activateHandler
SettingsProvider.deactivateHandler
SettingsProvider.hasSearchInterestHandler
SettingsProvider.inspectorUpdateHandler
Namespace: Scylla.Core.Editor
Assembly: ScyllaCore.Editor.dll
Syntax
public sealed class ScyllaSettingsProvider : SettingsProvider
Remarks

Unity discovers this provider automatically through the [SettingsProvider] attribute on the CreateSettingsProvider() factory method. No manual registration is required.

This page is currently a placeholder. Scylla Framework configuration is managed through UnityEngine.ScriptableObject-based configuration assets (ScyllaCoreConfiguration, ScyllaLoggerConfiguration, etc.) rather than through the Project Settings window. The page displays guidance on where to find those assets.

Search keywords ("scylla", "framework", "module", "bootstrap") are registered with Unity's settings search so the page can be found by typing relevant terms in the Project Settings search bar.

Constructors

ScyllaSettingsProvider(string, SettingsScope)

Initializes a new ScyllaSettingsProvider for the given path and scope, forwarding the predefined search keywords to the base UnityEditor.SettingsProvider constructor so Unity's settings search can surface this page.

Declaration
public ScyllaSettingsProvider(string path, SettingsScope scopes)
Parameters
Type Name Description
string path

The slash-separated path of the settings page within the Project Settings window (e.g. "Project/Scylla"). This value is defined by PROJECT_SETTINGS_PATH.
SettingsScope scopes

The UnityEditor.SettingsScope that determines where the settings page appears. Use UnityEditor.SettingsScope.Project for project-wide settings stored in the repository, or UnityEditor.SettingsScope.User for per-user settings.

Methods

CreateSettingsProvider()

Factory method invoked by Unity via the [SettingsProvider] attribute to register this page in the Project Settings window.

Declaration
[SettingsProvider]
public static SettingsProvider CreateSettingsProvider()
Returns
Type Description
SettingsProvider

A new ScyllaSettingsProvider instance registered at PROJECT_SETTINGS_PATH with UnityEditor.SettingsScope.Project scope.

OnActivate(string, VisualElement)

Called by Unity when this settings page is selected in the Project Settings window. Reserved for future use; currently performs no initialization.

Declaration
public override void OnActivate(string searchContext, VisualElement rootElement)
Parameters
Type Name Description
string searchContext

The active search string in the Project Settings search bar, if any. Can be used to highlight relevant controls when the page is opened via a search result.
VisualElement rootElement

The root UnityEngine.UIElements.VisualElement for UI Toolkit-based providers. This provider uses IMGUI via OnGUI(string) and does not populate this element.
Overrides

OnDeactivate()

Called by Unity when this settings page is deselected or the Project Settings window is closed. Releases the cached UnityEditor.SerializedObject wrapper.

Declaration
public override void OnDeactivate()
Overrides
UnityEditor.SettingsProvider.OnDeactivate()

OnGUI(string)

Renders the settings page content using IMGUI. Draws a scrollable view containing the Scylla Framework header and a placeholder info box with guidance on where to find module configuration assets.

Declaration
public override void OnGUI(string searchContext)
Parameters
Type Name Description
string searchContext

The active search string from the Project Settings search bar. Currently unused; all content is always displayed regardless of search terms.
Overrides

Extension Methods