Version: 2019.4
  • C#


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.




public static bool HasKey(string key);


key Name of key to check for.


bool The existence or not of the key.


Returns true if key exists in the preferences file.

The preferences file is examined to identify whether the specified key exists. True or false is returned. In the following example a key and value can be written into the preference file, or deleted. The existence of the key is checked with the HasKey function and a message displayed.

Use save, delete, and HasKey preference check.

// Small example where the XyZ key can be saved or deleted from the Preferences file.
// The existence of the key is checked using the HasKey() function.

using UnityEngine; using UnityEditor;

public class HasKeyExample : EditorWindow { private string keyName = "XyZ";

[MenuItem("Examples/HasKey Example")] static void Init() { HasKeyExample window = (HasKeyExample)EditorWindow.GetWindowWithRect( typeof(HasKeyExample), new Rect(0, 0, 250, 80)); window.Show(); }

void OnGUI() { EditorGUILayout.BeginHorizontal();

if (GUILayout.Button("Save '" + keyName + "' as Key")) EditorPrefs.SetString(keyName, "abc123");

if (GUILayout.Button("Delete Key '" + keyName + "'")) EditorPrefs.DeleteKey(keyName);


GUILayout.Label(keyName + " key exists: " + EditorPrefs.HasKey(keyName));

if (GUILayout.Button("Close")) this.Close(); }

// delete the key each time the demo starts void OnFocus() { EditorPrefs.DeleteKey(keyName); } }