class in UnityEngine
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseStores and accesses player preferences between game sessions.
Editor/Standalone
On macOS PlayerPrefs are stored in ~/Library/Preferences folder,
in a file named unity.[company name].[product name].plist, where company and product names are the names set up in Project Settings.
On macOS, PlayerPrefs are stored in ~/Library/Preferences/com.ExampleCompanyName.ExampleProductName.plist
. Unity uses the same .plist file for projects in the Editor and standalone Players.
standalone players.
On Windows, PlayerPrefs are stored in HKCU\Software\ExampleCompanyName\ExampleProductName
key.
On Linux, PlayerPrefs are stored in ~/.config/unity3d/ExampleCompanyName/ExampleProductName
.
On Windows Store Apps, PlayerPrefs are stored in %userprofile%\AppData\Local\Packages\[ProductPackageId]\LocalState\playerprefs.dat
.
On Android, PlayerPrefs are stored in /data/data/pkg-name/shared_prefs/pkg-name.v2.playerprefs.xml
. Unity stores PlayerPrefs data on the device, in SharedPreferences. C#, JavaScript, Android Java and native code can all access the PlayerPrefs data.
On Windows, PlayerPrefs are stored in the registry under
HKCU\Software\[company name]\[product name] key, where company and product names are
the names set up in Project Settings.
On Linux, PlayerPrefs can be found in ~/.config/unity3d/[CompanyName]/[ProductName] again using the company and product names specified in the Project Settings.
On macOS, PlayerPrefs are stored in /Library/Preferences/[bundle identifier].plist
.
On Windows, PlayerPrefs are stored in HKCU\Software\Unity\UnityEditor\ExampleCompanyName\ExampleProductName
key. Windows 10 uses the application’s PlayerPrefs names. For example, Unity adds a DeckBase
string and converts it into DeckBase_h3232628825. The application ignores the extension.
On Android data is stored (persisted) on the device. The data is saved in SharedPreferences. C#/JavaScript, Android Java and Native code can all access the PlayerPrefs data. The PlayerPrefs data is physically stored in /data/data/pkg-name/shared_prefs/pkg-name.xml.
On WebGL, PlayerPrefs are stored using the browser's IndexedDB API.
On iOS, PlayerPrefs are stored in
/Library/Preferences/[bundle identifier].plist.
DeleteAll | Removes all keys and values from the preferences. Use with caution. |
DeleteKey | Removes key and its corresponding value from the preferences. |
GetFloat | Returns the value corresponding to key in the preference file if it exists. |
GetInt | Returns the value corresponding to key in the preference file if it exists. |
GetString | Returns the value corresponding to key in the preference file if it exists. |
HasKey | Returns true if key exists in the preferences. |
Save | Writes all modified preferences to disk. |
SetFloat | Sets the value of the preference identified by key. |
SetInt | Sets the value of the preference identified by key. |
SetString | Sets the value of the preference identified by key. |