Class PlayURSettingsProvider

Inheritance
object
SettingsProvider
PlayURSettingsProvider
Inherited Members
SettingsProvider.OnDeactivate()
SettingsProvider.OnTitleBarGUI()
SettingsProvider.OnFooterBarGUI()
SettingsProvider.OnInspectorUpdate()
SettingsProvider.Repaint()
SettingsProvider.PopulateSearchKeywordsFromGUIContentProperties<T>()
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: PlayUR
Assembly: PlayUR.Editor.dll
Syntax
public class PlayURSettingsProvider : SettingsProvider

Constructors

| Improve this Doc View Source

PlayURSettingsProvider(string, SettingsScope)

Declaration
public PlayURSettingsProvider(string path, SettingsScope scope = SettingsScope.User)
Parameters
Type Name Description
string path
SettingsScope scope

Fields

| Improve this Doc View Source

configuration

Declaration
public Configuration configuration
Field Value
Type Description
Configuration
| Improve this Doc View Source

loadingConfig

Declaration
public bool loadingConfig
Field Value
Type Description
bool
| Improve this Doc View Source

previewGroup

Declaration
public ExperimentGroup? previewGroup
Field Value
Type Description
ExperimentGroup?

Methods

| Improve this Doc View Source

CreateMyCustomSettingsProvider()

Initializes and creates the setting provider

Declaration
[SettingsProvider]
public static SettingsProvider CreateMyCustomSettingsProvider()
Returns
Type Description
SettingsProvider
| Improve this Doc View Source

IsSettingsAvailable()

Shows or Hides the settings based of the return value

Declaration
public static bool IsSettingsAvailable()
Returns
Type Description
bool
| Improve this Doc View Source

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 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.
Overrides
| Improve this Doc View Source

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 override void OnGUI(string searchContext)
Parameters
Type Name Description
string searchContext

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