Version: 2018.1 (switch to 2018.2b or 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

EditorPrefs.GetString

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 method GetString(key: string, defaultValue: string = ""): string;
public static string GetString(string key, string defaultValue = "");

Description

Returns the value corresponding to key in the preference file if it exists.

If the value doesn't exist, it will return defaultValue. Note that EditorPrefs does not support null strings, so if defaultValue is null, an empty string is returned.


Quick notes that last between Unity Sessions.

// Simple Editor Script that lets you create / save quick notes
// Between Unity Sessions.

class QuickNotes extends EditorWindow {

var note : String = "Notes:\n->\n->";

@MenuItem("Examples/QuickNotes") static function Init() { var window = GetWindow(QuickNotes); window.Show(); }

function OnGUI() { note = EditorGUILayout.TextArea(note, GUILayout.Width(position.width-5), GUILayout.Height(position.height - 30)); EditorGUILayout.BeginHorizontal(); if(GUILayout.Button("Reset")) note = ""; if(GUILayout.Button("Clear Story",GUILayout.Width(72))) { note = "Notes:\n->\n->"; } EditorGUILayout.EndHorizontal(); }

function OnFocus() { if(EditorPrefs.HasKey("QuickNotes")) note = EditorPrefs.GetString("QuickNotes"); }

function OnLostFocus() { EditorPrefs.SetString("QuickNotes",note); }

function OnDestroy() { EditorPrefs.SetString("QuickNotes",note); } }
// Simple Editor Script that lets you create / save quick notes
// Between Unity Sessions.

using UnityEngine; using UnityEditor;

public class ExampleClass : EditorWindow { string note = "Notes:\n->\n->";

[MenuItem("Examples/QuickNotes")] static void Init() { ExampleClass window = (ExampleClass)EditorWindow.GetWindow(typeof(ExampleClass)); window.Show(); }

void OnGUI() { note = EditorGUILayout.TextArea(note, GUILayout.Width(position.width - 5), GUILayout.Height(position.height - 30)); EditorGUILayout.BeginHorizontal(); if (GUILayout.Button("Reset")) note = ""; if (GUILayout.Button("Clear Story", GUILayout.Width(72))) { note = "Notes:\n->\n->"; } EditorGUILayout.EndHorizontal(); }

void OnFocus() { if (EditorPrefs.HasKey("QuickNotes")) note = EditorPrefs.GetString("QuickNotes"); }

void OnLostFocus() { EditorPrefs.SetString("QuickNotes", note); }

void OnDestroy() { EditorPrefs.SetString("QuickNotes", note); } }

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