Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetString

Gets the string that corresponds to key in the player preferences.
Read time 1 minuteLast updated 4 days ago

Definition

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

GetString(string, string)

Gets the string that corresponds to 
key
in the player preferences.
public static string GetString(string key, string defaultValue)

Parameters

key

string
The key used to retrieve the corresponding string in the player preferences.

defaultValue

string
The value to return when no string is found for the given 
key
in the player preferences.

Returns

Type

Description

stringThe string corresponding to the given 
key
, 
defaultValue
if no string is found for the given 
key
.

Remarks

Returns given 
defaultValue
if no string is found for the given 
key
.

Examples

//Use this script to fetch the settings and show them as text on the screen.using UnityEngine;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);    }}

GetString(string)

Gets the string that corresponds to 
key
in the player preferences.
public static string GetString(string key)

Parameters

key

string
The key used to retrieve the corresponding string in the player preferences.

Returns

Type

Description

stringThe string corresponding to the given 
key
, 
string.Empty
if no string is found for the given 
key
.

Remarks

Returns 
string.Empty
if no string is found for the given 
key
.