Legacy Documentation: Version 2018.2 (Go to current version)
  • C#


class in UnityEditor

Suggest a change


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.




The PreferenceItem attribute allows you to add preferences sections to the Preferences Window.

The PreferenceItem attribute turns any static function into an OnGUI callback. Only static functions can use the PreferenceItem attribute.

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); } }


PreferenceItemCreates a section in the Preferences Window called name and invokes the static function following it for the section's GUI.

Did you find this page useful? Please give it a rating: