Class

Namespace

CoreFramework.Settings

The CoreFrameworkProjectSettingsProvider class is a SettingsProvider responsible for displaying and managing project settings in the Unity Editor.

public class CoreFrameworkProjectSettingsProvider : SettingsProvider

Inheritance

object

SettingsProvider

Extension Methods

TaskExtensions.AsCompletedTask<T>(T)

Constructors

CoreFrameworkProjectSettingsProvider(string, SettingsScope, IEnumerable<string>)

Creates an instance of the CoreFrameworkProjectSettingsProvider.

private CoreFrameworkProjectSettingsProvider(string path, SettingsScope scopes = SettingsScope.Project, IEnumerable<string> keywords = null)

Parameters

path string

The path of the settings provider, e.g., “Preferences/Core Framework/Settings”.

scopes SettingsScope

The scope of the settings provider (default is SettingsScope.Project).

keywords IEnumerable<string>

Keywords associated with the settings provider.

Fields

KSettingsPath

The path of the settings provider in the Preferences window.

private const string KSettingsPath = "Project/Core Framework/Settings"

Field Value

string

Methods

BootFieldChanged(ChangeEvent<string>)

private static void BootFieldChanged(ChangeEvent<string> evt)

Parameters

evt ChangeEvent<string>

CreateCoreFrameworkProjectSettingsProvider()

Creates an instance of the $CLASS and registers it with the [SettingsProvider] attribute.

[SettingsProvider]
public static SettingsProvider CreateCoreFrameworkProjectSettingsProvider()

Returns

SettingsProvider

The created CoreFrameworkProjectSettingsProvider instance.

OnGUI(string)

Use this function to draw the UI based on IMGUI. This assumes you haven't added any children to the rootElement passed to the OnActivate function.

public override void OnGUI(string searchContext)

Parameters

searchContext string

Search context for the Settings window. Used to show or hide relevant properties.

ProjectSettingsMenuItem()

Opens the Project Settings window at the specified path when the menu item is selected.

[MenuItem("Core Framework/Project Settings", priority = 0)]
private static void ProjectSettingsMenuItem()

StartFieldChanged(ChangeEvent<string>)

private static void StartFieldChanged(ChangeEvent<string> evt)

Parameters

evt ChangeEvent<string>