PreferenceItem
(Obsolete: use the SettingsProvider class instead) The PreferenceItem attribute allows you to add preferences sections to the Preferences window.
Read time 4 minutesLast updated 6 days ago
Definition
- Type: Class
- Namespace: UnityEditor
- Assembly: UnityEditor
- Inherits from: Attribute
- Implements: _Attribute
Warning
Deprecated. [PreferenceItem] is deprecated. Use [SettingsProvider] instead.
[AttributeUsage(AttributeTargets.Method)]public sealed class PreferenceItem : Attribute, _Attribute
Remarks
The PreferenceItem attribute turns any static function into an OnGUI callback. Only static functions can use the PreferenceItem attribute. By default all current PreferenceItems are included in the Unified Settings window and you get a warning to use the SettingsProvider attribute instead.
Examples
using UnityEngine;using UnityEditor;public class ExampleScript : MonoBehaviour{ // Have we loaded the prefs yet private static bool prefsLoaded = false; // The Preferences public static bool boolPreference = false; // Add preferences section named "My Preferences" to the Preferences window [PreferenceItem("My Preferences")] public static void PreferencesGUI() { // Load the preferences if (!prefsLoaded) { boolPreference = EditorPrefs.GetBool("BoolPreferenceKey", false); prefsLoaded = true; } // Preferences GUI boolPreference = EditorGUILayout.Toggle("Bool Preference", boolPreference); // Save the preferences if (GUI.changed) EditorPrefs.SetBool("BoolPreferenceKey", boolPreference); }}
Constructors
Constructor | Description |
|---|---|
| PreferenceItem(System.String) | Creates a section in the Settings Window called name and invokes the static function following it for the section's GUI. |