SettingsProviderAttribute
Attribute used to register a new SettingsProvider. Use this attribute to decorate a function that returns an instance of a SettingsProvider. If the function returns null, no SettingsProvider appears in the Settings window.
Read time 4 minutesLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEditor
- Assembly: UnityEditor
- Inherits from: Attribute
- Implements: _Attribute
[AttributeUsage(AttributeTargets.Method)]public sealed class SettingsProviderAttribute : Attribute, _Attribute
Examples
using System.IO;using System.Linq;using UnityEditor;class MyCustomSettingsProvider : SettingsProvider{ const string k_MyCustomSettingsPath = "Resources/MyCustomSettings.asset"; public MyCustomSettingsProvider(string path, SettingsScope scope) : base(path, scope) {} public static bool IsSettingsAvailable() { return File.Exists(k_MyCustomSettingsPath); } [SettingsProvider] public static SettingsProvider CreateMyCustomSettingsProvider() { if (IsSettingsAvailable()) { return new MyCustomSettingsProvider("MyCustomSettings", SettingsScope.Project); } // Settings Asset doesn't exist yet. No need to display anything in the Settings window. return null; }}
Constructors
Constructor | Description |
|---|---|
| SettingsProviderAttribute() | Creates a new SettingsProviderAttribute used to register new SettingsProvider. |