Version: 2019.1 (switch to 2018.3 or 2017.4)
LanguageEnglish
  • C#

EditorPrefs.DeleteKey

Other Versions
Leave feedback
Suggest a change

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.

Close

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.

Close

Cancel

public static void DeleteKey(string key);

Description

Removes key and its corresponding value from the preferences.


Removes a user entered editor preference, if it doesnt exists it prints a message.

// Removes a user entered editor preference.
// If it does not exists it prints a message.

using UnityEngine;
using UnityEditor;

public class DeleteKeyExample : EditorWindow
{
    string editorPref = "";

    [MenuItem("Examples/EditorPrefs/Clear Key Preference")]
    static void Init()
    {
        DeleteKeyExample window = GetWindowWithRect<DeleteKeyExample>(new Rect(0, 0, 250, 50));
        window.Show();
    }

    void OnGUI()
    {
        editorPref = EditorGUILayout.TextField("Editor key name:", editorPref);
        if (GUILayout.Button("Delete"))
            if (EditorPrefs.HasKey(editorPref))
            {
                if (EditorUtility.DisplayDialog("Removing " + editorPref + "?",
                    "Are you sure you want to " +
                    "delete the editor key " +
                    editorPref + "?, This action cant be undone",
                    "Yes",
                    "No"))
                    EditorPrefs.DeleteKey(editorPref);
            }
            else
            {
                EditorUtility.DisplayDialog("Could not find " + editorPref,
                    "Seems that " + editorPref +
                    " does not exists or it has been deleted already, " +
                    "check that you have typed correctly the name of the key.",
                    "Ok");
            }
    }
}

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

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2019 Unity Technologies. Publication: 2019.1-002V. Built: 2019-04-15.
TutorialsCommunity AnswersKnowledge BaseForumsAsset Store