Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetString

Returns the value corresponding to key in the preference file if it exists.
Read time 2 minutesLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor.CoreModule

GetString(string, string)

Returns the value corresponding to
key
in the preference file if it exists.
public static string GetString(string key, string defaultValue)

Parameters


defaultValue

Returns

Type

Description

string

Remarks

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.
QuickNotes (GetString)
Quick notes that last between Unity Sessions.

Examples

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

GetString(string)

Returns the value corresponding to
key
in the preference file if it exists.
public static string GetString(string key)

Parameters

Returns

Type

Description

string

Remarks

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.
QuickNotes (GetString)
Quick notes that last between Unity Sessions.

Examples

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