Saving and Loading Game Data

# CHAPTER 14

Saving and Loading Game Data #

1. Introduction #

2. Learning Objectives #

• Use simple key-value stores (like Unity's PlayerPrefs) for basic saves.

• Understand the concept of "Serialization."

• Create a dedicated C# Data Class to hold player progress.

• Convert C# objects to JSON strings using JsonUtility.

• Use the System.IO namespace to write and read text files to the hard drive.

3. The Simple Way: PlayerPrefs #

// Saving Data
PlayerPrefs.SetInt("HighScore", 5000);
PlayerPrefs.Save(); // Locks it to the hard drive

// Loading Data (The '0' is a default value if no save exists)
int myScore = PlayerPrefs.GetInt("HighScore", 0);

*Warning:* PlayerPrefs is strictly for simple data. If you have an inventory of 50 items and a complex quest log, using PlayerPrefs becomes a nightmare. You need JSON.

4. Structuring Data (The Data Class) #

[System.Serializable] // This tells C# "You are allowed to convert this to text!"
public class PlayerSaveData
{
    public int level;
    public float health;
    public string playerName;
    // We can even store arrays!
    public string[] inventoryItems;
}

5. Serialization (Converting to JSON) #

PlayerSaveData data = new PlayerSaveData();
data.level = 5;
data.playerName = "Arthur";

// Serialize it!
string jsonText = JsonUtility.ToJson(data);

// jsonText now looks like this: '{"level":5, "playerName":"Arthur"}'

6. Writing to the Hard Drive (System.IO) #

• Application.persistentDataPath: This is a magical engine variable that points to a safe folder on the user's computer (like AppData on Windows) where games are always allowed to write files.

using System.IO;

public void SaveGame()
{
    // 1. Package the data
    PlayerSaveData data = new PlayerSaveData();
    data.level = 5;

    // 2. Convert to JSON text
    string json = JsonUtility.ToJson(data);

    // 3. Define the file path
    string path = Application.persistentDataPath + "/save.json";

    // 4. Write the file to the hard drive
    File.WriteAllText(path, json);
    Console.WriteLine("Game Saved to: " + path);
}

7. Reading from the Hard Drive (Deserialization) #

public void LoadGame()
{
    string path = Application.persistentDataPath + "/save.json";

    // 1. Check if the file actually exists!
    if (File.Exists(path))
    {
        // 2. Read the text from the hard drive
        string json = File.ReadAllText(path);

        // 3. Convert the JSON text back into a C# Object (Deserialization)
        PlayerSaveData loadedData = JsonUtility.FromJson<PlayerSaveData>(json);

        // 4. Apply the loaded data to the game
        player.level = loadedData.level;
        Console.WriteLine("Game Loaded successfully!");
    }
}

8. Visual Learning: The Save Pipeline #

[ C# RAM (PlayerSaveData Object) ]
  level = 5, health = 100
          |
    (JsonUtility.ToJson)
          |
          v
[ Hard Drive (save.json file) ]
  '{"level":5, "health":100}'
          |
    (JsonUtility.FromJson)
          |
          v
[ C# RAM (Loaded back into the Game!) ]

9. Best Practices #

• Separate Save Logic from Game Logic: Do not put the File.WriteAllText() logic inside the Player script. Create a SaveManager script. The Player script simply says, "Here is my health, please save it," and the SaveManager handles the complex file IO operations.

10. Common Mistakes #

• Saving Engine Components: You *cannot* serialize a GameObject, a Transform, or a Sprite. If you try to write public GameObject player; inside your PlayerSaveData class, the JSON serialization will crash. You can only save primitive data: int, float, string, bool, and arrays of those primitives. To save a player's position, you must save three floats (x, y, z) and manually rebuild the Vector3 when loading!

11. Practice Exercises #

1. 1. What does the [System.Serializable] tag do when placed above a C# class?

1. 2. Why is Application.persistentDataPath used instead of hardcoding a path like C:/Desktop/MyGame?

12. MCQs with Answers #

13. Interview Questions #

• Q: Explain the concept of Serialization and Deserialization in C#. Why is this translation process necessary for writing game progress to a hard drive?

• Q: Contrast PlayerPrefs with JSON Serialization. For a massive open-world RPG, why is JSON the preferred architecture?

• Q: A junior developer attempts to save the game by placing public Transform playerTransform; inside their SaveData class. The JSON serialization fails. Explain why Unity/C# cannot serialize engine components, and how to fix this using primitive data types.

14. FAQs #

15. Summary #

16. Next Chapter Recommendation #