Class ScriptableSettingsProvider<T>
Expose a ScriptableSettings of type T as a settings provider
Inherited Members
Namespace: Unity.XRTools.Utils
Syntax
public abstract class ScriptableSettingsProvider<T> : ScriptableSettingsProviderBase<T> where T : ScriptableSettingsBase<T>Type Parameters
| Name | Description |
|---|---|
| T | The ScriptableSettings type which will be exposed |
Constructors
ScriptableSettingsProvider(String, SettingsScope)
Initialize a new ScriptableSettingsProvider
Declaration
protected ScriptableSettingsProvider(string path, SettingsScope scope = null)Parameters
| Type | Name | Description |
|---|---|---|
| String | path | The path to this settings view within the Preferences or Project Settings window |
| SettingsScope | scope | The scope of these settings |
Properties
serializedObject
A SerializedObject representing the ScriptableSettings being provided
Declaration
protected static SerializedObject serializedObject { get; }Property Value
| Type | Description |
|---|---|
| SerializedObject |
target
The ScriptableSettings being provided
Declaration
protected static T target { get; }Property Value
| Type | Description |
|---|---|
| T |
Methods
OnActivate(String, VisualElement)
Use this function to implement a handler for when the user clicks on the Settings in the Settings window. You can fetch a settings Asset or set up UIElements UI from this function.
Declaration
public abstract override void OnActivate(string searchContext, VisualElement rootElement)Parameters
| Type | Name | Description |
|---|---|---|
| String | searchContext | Search context in the search box on the Settings window. |
| VisualElement | rootElement | Root of the UIElements tree. If you add to this root, the SettingsProvider uses UIElements instead of calling SettingsProvider.OnGUI to build the UI. If you do not add to this VisualElement, then you must use the IMGUI to build the UI. |
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.
Declaration
public abstract override void OnGUI(string searchContext)Parameters
| Type | Name | Description |
|---|---|---|
| String | searchContext | Search context for the Settings window. Used to show or hide relevant properties. |