Version: 2021.3
LanguageEnglish
  • C#

PlayerPrefs.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

Declaration

public static string GetString(string key);

Declaration

public static string GetString(string key, string defaultValue);

Description

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

If it doesn't exist, PlayerPrefs.GetString will return defaultValue.

//Use this script to fetch the settings and show them as text on the screen.

using UnityEngine; using UnityEngine.UI;

public class PlayerPrefsGetStringExample : MonoBehaviour { string m_PlayerName;

void Start() { //Fetch the PlayerPref settings SetText(); }

void SetText() { //Fetch name (string) from the PlayerPrefs (set these PlayerPrefs in another script). If no string exists, the default is "No Name" m_PlayerName = PlayerPrefs.GetString("Name", "No Name"); }

void OnGUI() { //Fetch the PlayerPrefs settings and output them to the screen using Labels GUI.Label(new Rect(50, 50, 200, 30), "Name : " + m_PlayerName); } }