Unity - Scripting API: AssetSettingsProvider
class in UnityEditor
/
Inherits from:SettingsProvider
Success!
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
Submission failed
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Description
AssetSettingsProvider is a specialization of the SettingsProvider class that converts legacy settings to Unified Settings. Legacy settings include any settings that used the Inspector to modify themselves, such as the *.asset files under the ProjectSettings folder. Under the hood, AssetSettingsProvider creates an Editor for specific Assets and builds the UI for the Settings window by wrapping the Editor.OnInspectorGUI function.
Internally we use this class to wrap our existing settings.
Properties
Constructors
| AssetSettingsProvider | Creates a new AssetSettingsProvider so you can wrap legacy settings (that is, settings that previously appeared in the Inspector). |
Public Methods
| OnActivate | Overrides SettingsProvider.OnActivate for this AssetSettingsProvider. |
| OnDeactivate | Overrides SettingsProvider.OnDeactivate for this AssetSettingsProvider. |
| OnFooterBarGUI | Overrides SettingsProvider.OnFooterBarGUI for this AssetSettingsProvider. |
| OnGUI | Overrides SettingsProvider.OnGUI for this AssetSettingsProvider. |
| OnTitleBarGUI | Overrides SettingsProvider.OnTitleBarGUI for this AssetSettingsProvider. This draws the button bar that contains the "add to preset" and the "help" buttons. |
Static Methods
Inherited Members
Properties
| activateHandler | Overrides SettingsProvider.OnActivate. |
| deactivateHandler | Overrides SettingsProvider.OnDeactivate. |
| footerBarGuiHandler | Overrides SettingsProvider.OnFooterBarGUI. |
| guiHandler | Overrides SettingsProvider.OnGUI. |
| hasSearchInterestHandler | Overrides SettingsProvider.HasSearchInterest. |
| inspectorUpdateHandler | Overrides SettingsProvider.OnInspectorUpdate. |
| keywords | Gets or sets the list of keywords to compare against what the user is searching for. When the user enters values in the search box on the Settings window, SettingsProvider.HasSearchInterest tries to match those keywords to this list. |
| label | Gets or sets the display name of the SettingsProvider as it appears in the Settings window. If not set, the Settings window uses last token of SettingsProvider.settingsPath instead. |
| scope | Gets the Scope of the SettingsProvider. The Scope determines whether the SettingsProvider appears in the Preferences window (SettingsScope.User) or the Settings window (SettingsScope.Project). |
| settingsPath | Gets Path used to place the SettingsProvider in the tree view of the Settings window. The path should be unique among all other settings paths and should use "/" as its separator. |
| titleBarGuiHandler | Overrides SettingsProvider.OnTitleBarGUI. |
Public Methods
| HasSearchInterest | Checks whether the SettingsProvider should appear when the user types something in the Settings window search box. SettingsProvider tries to match the search terms (even partially) to any of the SettingsProvider.keywords. The search is case insensitive. |
| OnInspectorUpdate | OnInspectorUpdate is called at 10 frames per second to give the inspector a chance to update. See EditorWindow.OnInspectorUpdate for more details. |
| Repaint | Request the SettingsWindow for a repaint. |