Сохранение и загрузка данных в Unity игре

Большинство проектов созданных в Unity часто имеют систему хранения игровых данных. Эта система включает в себя инструменты для сохранения и загрузки данных. Как и где хранить эти данные часто зависит от того что это за игра, кто в нее играет и какое кол-во данных необходимо сохранить. Обычно различают два вида хранения данных: локальную, облачную (удаленную) и комбинированную.

Локальную систему хранения данных часто используют в одиночных играх, где необходимо хранить несущественные данные, вроде прогресса прохождения или характеристик персонажей и тд.

Облачную систему чаще используют для многопользовательских проектов. В таких проектах игре необходимо иметь доступ к данным всех игроков, поэтому они используют сервера, где хранятся эти данные.

Комбинированную систему обычно используют в проектах, нацеленных как на одиночную игру, так и на многопользовательскую. В таких проектах необходимо хранить данные локально и удаленно.

В этой статье рассмотрим локальный тип хранения данных, и для этого в Unity есть очень простой инструмент PlayerPrefs.

PlayerPrefs – это небольшой набор методов для сохранения и загрузки данных из реестра системы. Сам реестр используется для иерархического хранения данных и настроек системы. В отличие от файловой системы, где хранятся файлы с любыми данными и которые доступны всем пользователям компьютера, в реестре хранятся только настройки программы с самыми необходимыми данными которые доступны только определенным пользователям, а PlayerPrefs, в свою очередь, позволяет записывать и считывать эти самые данные из реестра.

Методы работы

Для начала рассмотрим способы записи данных в реестр с помощью PlayerPrefs.

Система имеет несколько методов и все они работают по одному и тому же принципу: сначала указываем ключ под которым хотим записать данные, после чего указываем сами данные которые необходимо записать.

• SetInt. Метод используется для записи целого числа(integer) в реестр.
• SetFloat. Метод для записи числа с “плавающей” запятой или дробного числа(float).
• SetString. Метод для записи текстовых данных.

Для загрузки есть аналогичные методы, которые возвращают сохраненные ранее данные под определенным ключом.

• GetInt. Метод используется для считывания целого числа(integer) из реестра.
• GetFloat. Метод для считывания дробного числа(float).
• GetString. Метод для считывания текстовых данных.

И так, мы разобрали основные методы для работы с PlayerPrefs, теперь попробуем сохранить с помощью этой системы некоторые данные в игре.

Игра представляет собой небольшую аркаду в которой необходимо отстреливать инопланетные корабли до того как они захватят главную базу.

Начнем с простого сохранения кол-ва уничтоженных кораблей.

Создадим небольшой скрипт Control унаследованный от MonoBehaviour.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  
5. }

В числовой переменной kills будем хранить кол-во уничтоженных кораблей.

Теперь добавим метод сохранения Save.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  
5.  public void Save() {}
6.  
7. }

В игре этот метод вызывается через UI кнопку.

После нажатия этой кнопки переменная kills запишется в реестр под указанным ключом.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  
5.  public void Save() {
6.   string key = “MyGame”;
7.   PlayerPrefs.SetInt(key, this.kills);
8.   PlayerPrefs.Save();
9.  }
10.  
11. }

И так первым действие указываем в переменной key ключ под которым необходимо будет записать данные, пусть, к примеру название ключа будет MyGame, далее вызываем метод SetInt в который передаем ключ и переменную kills, в конце завершаем запись данных в реестре с помощью метода Save.

Пробуем протестировать.

Проверить записи данных можно в реестре. Для быстрого входа в реестр необходимо нажать комбинацию кнопок Win + R, после чего в окошке “Выполнить” ввести regedit и нажать “Ok”.

Далее необходимо найти раздел с игрой. Все данные unity проектов хранятся в разделе HKEY_CURRENT_USER/Software/Unity/UnityEditor/DefaultCompany в этом разделе находим проектом по названию, там и будут храниться все записи программы.

В разделе “Параметр” можно увидеть название ключа под которым записаны данные, а в разделе “Значение” число равное кол-ву уничтоженных кораблей в игре.

Именно в этом разделе мы будем хранить все остальные данные из игры.

Загрузка данных

Теперь необходимо произвести чтение данных из реестра.

Загрузку будет проводить при старте игры, для этого заведем новый метод Start в скрипте Control.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  
5.  private void Start() {
6.   Load();
7.  }
8.  
9.  private void Load() {
10.   string key = “MyGame”;
11.  }
12.  
13.  /*…метод Save…*/
14.  
15. }

В методе Load, в переменную key укажем ключ под которым записаны наши данные.

Теперь с помощью условия проверим: существуют ли наш ключ в реестре, для этого используем метод HasKey.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  
5.  private void Start() {
6.   Load();
7.  }
8.  
9.  private void Load() {
10.   string key = “MyGame”;
11.   if (PlayerPrefs.HasKey(key)) {
12.    
13.   }
14.  }
15.  
16.  /*…метод Save…*/
17.  
18. }

Если ключ существует значит можно загрузить данные из реестра.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  
5.  private void Start() {
6.   Load();
7.  }
8.  
9.  private void Load() {
10.   string key = “MyGame”;
11.   if (PlayerPrefs.HasKey(key)) {
12.    this.kills = PlayerPrefs.GetInt(key);
13.   }
14.  }
15.  
16.  /*…метод Save…*/
17.  
18. }

Проверяем.

Отлично, данные загрузились.

Комплексные данные

И так, теперь мы научились сохранять и загружать самые элементарные данные из реестра. Теперь попробуем проделать все тоже самое с кол-во очков в игре, для этого объявим новую дробную переменную scores.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  
6. }

Теперь немного расширим метод Save, чтобы сохранить эту новую переменную в реестр.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  
6.  public void Save() {
7.   string key = “MyGame”;
8.   PlayerPrefs.SetInt(key, this.kills);
9.   PlayerPrefs.SetFloat(key, scores);
10.   PlayerPrefs.Save();
11.  }
12.  
13. }

В методе Load проведем аналогичные действия только по загрузке переменной scores.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  
6.  private void Start() {
7.   Load();
8.  }
9.  
10.  private void Load() {
11.   string key = “MyGame”;
12.   if (PlayerPrefs.HasKey(key)) {
13.    this.kills = PlayerPrefs.GetInt(key);
14.    this.scores = PlayerPrefs.GetFloat(key);
15.   }
16.  }
17.  
18.  /*…метод Save…*/
19.  
20. }

Запускаем игру, чтобы проверить работоспособность системы.

Текстовые данные

У методов записи и загрузки данных есть один недостаток, заключается он в том, что под одним ключом может храниться только одна переменная определенного типа. Мы уже использовали ячейки для записи целого числа int и дробного float, больше данный ключ вместить данных не может, но в игре еще остались данные которые необходимо записать в реестр – это кол-во жизней главной базы.

Кол-во жизней базы это тоже дробное число float, а так как ячейка дробного числа уже занята переменной scores, то получается, что мы не сможем поместить еще одну. В этом случае на помощь приходят текстовые данные. Мы просто преобразуем все данные для сохранения в текст и запишем его в реестр в текстовую ячейку, которая все еще пустая. Для удобного преобразования множества данных в текст и обратно используем JSONUtility.

JSON – это удобный текстовый формат хранения данных. Он преобразует любой объект в читаемый текст и обратно. С помощью него можно хранить практически любое кол-во данных в виде текста.

И так объявим новую переменную health в скрипте Control где будем хранить кол-во жизней базы.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  public float health = 100;
6.  
7. }

Теперь нам нужен объект который будет хранить все эти три переменные. Для этого подойдет простой класс SaveData. Создадим новый скрипт SaveData и уберем у него наследование от MonoBehaviour.

1. public class SaveData {
2.  
3.  public int kills;
4.  public float scores;
5.  public float health;
6.  
7. }

Переходим в метод Save, откуда сотрем последние два действия SetInt и SetFloat.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  public float health = 100;
6.  
7.  public void Save() {
8.   string key = “MyGame”;
9.  
10.   SaveData data = new SaveData();
11.  
12.   PlayerPrefs.Save();
13.  }
14.  
15. }

Сначала создаем новый экземпляр класса SaveData, после чего наполняем его данными.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  public float health = 100;
6.  
7.  public void Save() {
8.   string key = “MyGame”;
9.  
10.   SaveData data = new SaveData();
11.   data.kills = this.kills;
12.   data.scores = this.scores;
13.   data.health = this.health;
14.  
15.   PlayerPrefs.Save();
16.  }
17.  
18. }

Теперь необходимо преобразовать объект data в текст, для чего воспользуемся методом ToJson класса JsonUtility.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  public float health = 100;
6.  
7.  public void Save() {
8.   string key = “MyGame”;
9.  
10.   SaveData data = new SaveData();
11.   data.kills = this.kills;
12.   data.scores = this.scores;
13.   data.health = this.health;
14.  
15.   string value = JsonUtility.ToJson(data);
16.  
17.   PlayerPrefs.Save();
18.  }
19.  
20. }

После чего сохраняем полученный текст в реестр с помощью метода SetString.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  public float health = 100;
6.  
7.  public void Save() {
8.   string key = “MyGame”;
9.  
10.   SaveData data = new SaveData();
11.   data.kills = this.kills;
12.   data.scores = this.scores;
13.   data.health = this.health;
14.  
15.   string value = JsonUtility.ToJson(data);
16.   PlayerPrefs.SetString(key, value);
17.  
18.   PlayerPrefs.Save();
19.  }
20.  
21. }

Теперь необходимо проделать действия по загрузке данных в методе Load и перевести текст обратно в объект SaveData с помощью того же JSONUtility.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  public float health = 100;
6.  
7.  private void Start() {
8.   Load();
9.  }
10.  
11.  private void Load() {
12.   string key = “MyGame”;
13.   if (PlayerPrefs.HasKey(key)) {
14.    string value = PlayerPrefs.GetString(key);
15.   }
16.  }
17.  
18.  /*…метод Save…*/
19.  
20. }

Как и раньше проверяем существование ключа, после чего загружаем текст из реестра. Далее преобразуем полученный текст в объект SaveData с помощью метода FromJson класса JsonUtility.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  public float health = 100;
6.  
7.  private void Start() {
8.   Load();
9.  }
10.  
11.  private void Load() {
12.   string key = “MyGame”;
13.   if (PlayerPrefs.HasKey(key)) {
14.    string value = PlayerPrefs.GetString(key);
15.  
16.    SaveData data = JsonUtility.FromJson<SaveData>(value);
17.   }
18.  }
19.  
20.  /*…метод Save…*/
21.  
22. }

В методе FromJson, в фигурных скобках указываем тип объекта который мы хотим получить из текста, а в сам метод передаем текстовую переменную value в которой находится загруженный текст из реестра. Получив целый объект из текста применяем сохраненные значения переменных обратно.

1. public class Control : MonoBehaviour {
2.  
3.  public int kills = 0;
4.  public float scores = 0f;
5.  public float health = 100;
6.  
7.  private void Start() {
8.   Load();
9.  }
10.  
11.  private void Load() {
12.   string key = “MyGame”;
13.   if (PlayerPrefs.HasKey(key)) {
14.    string value = PlayerPrefs.GetString(key);
15.  
16.    SaveData data = JsonUtility.FromJson<SaveData>(value);
17.    this.kills = data.kills;
18.    this.scores = data.scores;
19.    this.health = data.health;
20.   }
21.  }
22.  
23.  /*…метод Save…*/
24.  
25. }

Запускаем для проверки.

Сохранение и загрузка работают исправно. Переходим в реестр и проверяем данные.

Теперь в разделе “Значение” мы видим текст со всеми переменными и их значениями.

Заключение

Сохранение и загрузка данных через PlayerPrefs имеет свои преимущества перед другими видами локального хранения данных: во первых простотой работы, вам не нужно работать с файлами и лезть в файловую систему вообще, во вторых при работе с  файловой системе, к примеру, на некоторых платформах вам нужно иметь разрешение на чтение и запись данных, для PlayerPrefs в этом нет необходимости он работает на всех устройствах одинаково. Поэтому PlayerPrefs отлично подходит для хранение небольшого кол-ва несложных данных на устройстве.

Ознакомится с проектом из статьи можно по ссылке.