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.
Close
PlayerPrefs
is a class that stores Player preferences between game sessions. It can store string, float and integer values into the user’s platform registry.
Unity stores PlayerPrefs in a local registry, without encryption. Do not use PlayerPrefs data to store sensitive data.
Unity stores PlayerPrefs
data differently based on which operating system the application runs on. In the file paths given on this page, the ExampleCompanyName and ExampleProductName are the names you set in Unity’s Player Settings.
Standalone player and in-Editor Play mode storage location
- MacOS: ~/Library/Preferences/com.ExampleCompanyName.ExampleProductName.plist
Standalone Player storage location
- Android: /data/data/pkg-name/shared_prefs/pkg-name.v2.playerprefs.xml
.
Notes:
PlayerPrefs
data and SharedPreferences.Editor API to modify it.PlayerPrefs
data.- iOS: Uses the [NSUserDefaults standardUserDefaults]
API to store PlayerPrefs data.
- Linux: ~/.config/unity3d/ExampleCompanyName/ExampleProductName
- WebGL: Unity stores up to 1MB of PlayerPrefs data using the browser's IndexedDB API. For more information, see IndexedDB.
- Windows: HKCU\Software\ExampleCompanyName\ExampleProductName
- Windows Universal Platform: %userprofile%\AppData\Local\Packages\[ProductPackageId]\LocalState\playerprefs.dat
In-Editor Play mode storage location
- Windows: HKCU\Software\Unity\UnityEditor\ExampleCompanyName\ExampleProductName
key. Note that Windows uses the key names from the application’s PlayerPrefs as a hashed identifier. For example, Unity adds a DeckBase
string to the hashed key name (for example h3232628825
) to create DeckBase_h3232628825
. Unity hashes the names because it:
The application ignores the extension.
DeleteAll | Removes all keys and values from the preferences. Use with caution. |
DeleteKey | Removes the given key from the PlayerPrefs. If the key does not exist, DeleteKey has no impact. |
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 the given key exists in PlayerPrefs, otherwise returns false. |
Save | Saves all modified preferences. |
SetFloat | Sets the float value of the preference identified by the given key. You can use PlayerPrefs.GetFloat to retrieve this value. |
SetInt | Sets a single integer value for the preference identified by the given key. You can use PlayerPrefs.GetInt to retrieve this value. |
SetString | Sets a single string value for the preference identified by the given key. You can use PlayerPrefs.GetString to retrieve this value. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.