RPGゲームのアイテムのデータをJSONファイルで用意

Last updated at 2020-12-06Posted at 2020-12-02

初めまして、新鮮な土筆です。
今回は、Unity #2 Advent Calendar 2020　3日目の記事を書きたいと思います。

#概要
RPGゲームに登場する敵とアイテムのデータをJSONファイルで管理したら、ショップとバトルで必要になるデータが扱いやすいと感じたので、
実際自分がやっているJSONファイルデータの作成方法とその使い方を、ゲームのアイテムデータ作成方法の説明を通して書きたいと思います。

sea_mountain さんの下記の記事を主に参考にしています。ありがとうございました。m(_ _)m
JsonUtility をつかって Unity で JSON を取り扱う方法

##なぜJSONファイルなのか
先にお伝えしたいのですが、私自身プログラムとゲーム作成は始めたばかりの新参ですので、詳しくご説明できません。
実際、ゲームに登場するアイテムのデータを管理する方法は複数あると思います。
ですが、JSONファイルを用いたのには3つの理由があります。

JSONファイルを用いると、ScriptableObjectのように1つ1つのデータをエディタ上で別々に開いて編集するのではなく、1つのファイルを開いて個々のアイテムデータを見比べながら編集できる。
必要に応じて簡単に値を編集出来るため、アイテムデータに依存するバトルの回復演出等で確認がすぐに出来る。
JSONファイルはUnityに依存しないので、Unityを触らない人もデータが用意できる(Googleスプレッドシートのほうが…、かもしれません。)

##アイテムデータの用意
下記のJSONファイルでゲームに登場するアイテムの情報をまとめています。
ショップでの買い物のやり取りに必要な情報や、バトルでのアイテム効果の情報をこのファイルから持ってきています。

データの内容は

アイテム画像名
アイテム名
アイテム説明
アイテムの種類 (HPやFP回復、攻撃)
量 (回復、攻撃)
購入価格
売却価格　となっています。

{
  "gameItems": [
    {
      "imgFileName": "english_muffin",
      "name": "ふつうのパン",
      "description" : "たべたら　元気がでる　パン\nHPが　「５」かいふくする",
      "type": "recoverHp",
      "amount": 5,
      "playersBuyingPrice": 5,
      "playersSellingPrice": 3
    },
    {
      "imgFileName": "food_rice_burger",
      "name": "めちゃうまのパン",
      "description" : "たべたら　かなり元気がでる　パン\nHPが　「１５」かいふくする",
      "type": "recoverHp",
      "amount": 10,
      "playersBuyingPrice": 10,
      "playersSellingPrice": 5
    }
  ]
}

Unityのプロジェクト内のResourcesフォルダに JSONフォルダを用意して、アイテムデータのJSONファイルをここにいれておきます。
今回のアイテムデータの名前は"GameItemsData.json"で保存しておきます。

##読み込みに必要なクラス

それでは次にJSONファイルの読み込み方法です。
上記でご紹介しました　JsonUtility をつかって Unity で JSON を取り扱う方法　の想定するJSONファイルのデータとは異なり、本記事では複数のアイテムデータをまとめた配列を扱います。
追記 : 2020/12/06
上記記事でもint型の配列は取り扱われていらっしゃいますので打ち消し線を加えました。

今回のアイテムデータを読み込むために、クラスを3つ用意します。

アイテムの個々の情報をしまうためのクラス

[System.Serializable]
public class Item
{
 public string imgFileName;
 public string name;
 public string description;
 public string type;
 public int amount;
 public int playersBuyingPrice;
 public int playersSellingPrice;
}

アイテムの個々の情報を持つクラスを配列にしまうためのクラス

public class ItemDataArray
{
 public Item[] gameItems;
}

JSONファイルのデータを読むための関数を用意するクラス

using UnityEngine;
public class JsonReaderFromResourcesFolder
{
 public ItemDataArray GetItemDataArray ()
 {
   string filePath = "JSON/GameItemsData";
   TextAsset file = Resources.Load (filePath) as TextAsset;
   ItemDataArray items = JsonUtility.FromJson<ItemDataArray> (file.text);
   return items;
 }
}

先に3つのクラスをザックリと紹介しました。
これから、3つのクラスの役割を上から順に説明することで、JSONファイルのデータを取り出す方法を説明します。

##アイテムの個々の情報をしまうためのクラス
JSONファイルに記載された個々のアイテムデータは下記の通りでした。

{
  "imgFileName": "english_muffin",
  "name": "ふつうのパン",
  "description" : "たべたら　元気がでる　パン\nHPが　「５」かいふくする",
  "type": "recoverHp",
  "amount": 5,
  "playersBuyingPrice": 5,
  "playersSellingPrice": 3
}

このデータをゲームで扱うには、それぞれが変数として扱われる際の型を指定する必要があります。
そのために下記のクラスを用意して型を指定しておきます。

[System.Serializable]
public class Item
{
 public string imgFileName;
 public string name;
 public string description;
 public string type;
 public int amount;
 public int playersBuyingPrice;
 public int playersSellingPrice;
}

この時に [System.Serializable] を書き忘れると、データを変数に代入できませんので注意してください。
また、Itemクラスに記述する変数名はJSONデータのものと同じにしておいてください。
これでアイテムの情報をItemクラスの変数として取り出すクラスが用意できました。

##アイテムの個々の情報を持つクラスを配列にしまうためのクラス
今回は複数のアイテムデータを保持した配列を読み込むため、そのためのクラスが必要です。
JSONファイルのデータは下記のようにアイテムのデータ配列を保持していました。

{
  "gameItems": [
    {
      -- 省略 --
    },
    {
      -- 省略 --
    }
  ]
}

この"gameItems"を扱うためのクラスを用意します。

public class ItemDataArray
{
 public Item[] gameItems;
}

上記で用意したItemクラスの配列型のクラスを用意することで、"gameItems"をItem[]で受け取ります。
ここでもクラスの変数名をJSONファイルに合わせてください。異なるとデータが受け取れないので注意です。

##JSONファイルのデータを読むための関数を用意するクラス
最後に、JSONファイルを読み込んで上記で用意した2つのクラスに合わせたデータに変換する処理を用意します。
まず下記のようにJSONファイルのデータを読むための関数を持つクラスを用意します。

using UnityEngine;

public class JsonReaderFromResourcesFolder
{
  public ItemDataArray GetItemDataArray ()
  {
    string filePath = "JSON/GameItemsData";
    TextAsset file = Resources.Load (filePath) as TextAsset;
    ItemDataArray items = JsonUtility.FromJson<ItemDataArray> (file.text);
    return items;
  }
}