Class PlayUROverrideSettingsProvider
Inherited Members
Namespace: PlayUR
Assembly: PlayUR.Editor.dll
Syntax
public class PlayUROverrideSettingsProvider : SettingsProvider
Constructors
| Improve this Doc View SourcePlayUROverrideSettingsProvider(string, SettingsScope)
Declaration
public PlayUROverrideSettingsProvider(string path, SettingsScope scope = SettingsScope.User)
Parameters
Type | Name | Description |
---|---|---|
string | path | |
SettingsScope | scope |
Methods
| Improve this Doc View SourceCreateMyCustomSettingsProvider()
Initializes and creates the setting provider
Declaration
[SettingsProvider]
public static SettingsProvider CreateMyCustomSettingsProvider()
Returns
Type | Description |
---|---|
SettingsProvider |
IsSettingsAvailable()
Shows or Hides the settings based of the return value
Declaration
public static bool IsSettingsAvailable()
Returns
Type | Description |
---|---|
bool |
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 SourceOnGUI(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. |