UnityC# 辞書(ディクショナリー)の使い方キーと値でデータを指定する

→ Unity入門の森オリジナル本格ゲーム制作講座はこちら
11種類の本格ゲームの全ソースコード公開・画像＆動画による解説付き

今回の記事では辞書型(ディクショナリー、Dictionary)について解説します。

辞書型も前回扱ったListクラスと同じくコレクションの一種になります。

前回の記事：

前回はインターフェースとポリモーフィズムについて学びましたが、今回の記事ではListについて解説していきます。前回の記事： Listは配列をより使いやすくしたコレクションの一つになります。配列より便利なListクラスとは Listクラス...

【Line登録者限定のプレゼントもあるよ！】

簡単にデータにアクセスできる辞書型(ディクショナリー)って何？
1. KeyValuePair<TKey, TValue>型について
2. 辞書型が継承しているインターフェース
【実践】Unityで辞書(ディクショナリー)を使ってみよう！
まとめ

簡単にデータにアクセスできる辞書型(ディクショナリー)って何？

辞書クラスではキーを使って要素を追加したり、削除したり、アクセスしたりする。

辞書型はキーとなる値とそれに対応する値のペアからなるコレクションになります。キーおよび値の型はテンプレートで別の型を指定できます。

要素にアクセスする時は配列やリストの場合は添字を使っていましたが、辞書型の場合はキーを使用します。そのため辞書型はリストより指定した値にアクセスしやすいコレクションになります。

その代わり、辞書型のデータの並びはこちらから制御できません。ループ処理の際には要素の順番に依存しない処理を書く必要があります。

主なメンバは次のものになります。

追加：Add(key, value)
削除：Remove(key)
キーチェック：Contains(key)
全てのキー：Keysプロパティ
全ての値：Valuesプロパティ

Dictionary<string, int> dict = new Dictionary<string, int>();

//要素を追加する時はキーと値を一緒に渡す。
dict.Add("Unity", 100);
dict.Add("Game", 200);
dict["Key"] = 300; //<- 添字のように使うこともできる。

//要素数とキーの確認
var c = dict.Count; // <- c == 3
var b = dict.Contains("Key"); // <- b == true

//要素の値にアクセスする時はキーを添字がわりに使う。
var n = dict["Key"]; // <- n == 300
dict["Key"] = -1; // <- 値を上書きしている。

//要素の削除にはキーを使う。
dict.Remove("Key"); 
b = dict.Contains("Key"); // <- b == false

//辞書型の要素のループにはforeachを使う
foreach(KeyValuePair<string, int> pair in dict) {
  var key = pair.Key; // <- キー
  var value = pair.Value; // <- ペアとなる値
}
//キーだけをループしたい時はKeysを使う。
foreach(var key in dict.Keys) { ... }
//値だけをループしたい時はValuesを使う。
foreach(var value in dict.Values) { ... }

Dictionary<string, int> dict = new Dictionary<string, int>();

//要素を追加する時はキーと値を一緒に渡す。

dict.Add("Unity", 100);

dict.Add("Game", 200);

dict["Key"] = 300; //<- 添字のように使うこともできる。

//要素数とキーの確認

var c = dict.Count; // <- c == 3

var b = dict.Contains("Key"); // <- b == true

//要素の値にアクセスする時はキーを添字がわりに使う。

var n = dict["Key"]; // <- n == 300

dict["Key"] = -1; // <- 値を上書きしている。

//要素の削除にはキーを使う。

dict.Remove("Key");

b = dict.Contains("Key"); // <- b == false

//辞書型の要素のループにはforeachを使う

foreach(KeyValuePair<string, int> pair in dict) {

var key = pair.Key; // <- キー

var value = pair.Value; // <- ペアとなる値

}

//キーだけをループしたい時はKeysを使う。

foreach(var key in dict.Keys) { ... }

//値だけをループしたい時はValuesを使う。

foreach(var value in dict.Values) { ... }

KeyValuePair<TKey, TValue>型について

辞書型はキーと値をKeyValuePair<TKey, TValue>型で管理しています。

KeyValuePair<TKey, TValue>型も辞書型と同じくテンプレートを使用しています。なのでテンプレートに型を指定する必要がありますが、こちらの場合は辞書型に渡したテンプレートの型を内部で設定してくれるのであまり気にする必要はありません。

KeyValuePair<TKey, TValue>型自体はとても簡単な内容になり、次のプロパティが定義されています。

Key：キーを表すプロパティ。
Value：値を表すプロパティ。

辞書型が継承しているインターフェース

辞書型は次のインターフェースを継承しています。

ICollection
ICollection<KeyValuePair<TKey,TValue>>
IReadOnlyCollection<KeyValuePair<TKey,TValue>>
IDictionary
IDictionary<TKey,TValue>
IReadOnlyDictionary<TKey,TValue>
IEnumerable<KeyValuePair<TKey,TValue>>
IEnumerable
ISerializable
IDeserializationCallback

辞書型で実装できることを知りたい場合は上記のインターフェースについて調べてみましょう。

【実践】Unityで辞書(ディクショナリー)を使ってみよう！

それでは辞書型をUnityで使用してみましょう！

残念ながら辞書型はUnityエディターが対応していないためInspectorから設定できません。

エディター拡張を使用するとInspectorから設定できるようになりますが、こちらからそれを実装するか、Web上で公開されているものを使うなど、Unity以外の別のスクリプトが必要になります。

今回の記事では辞書型の使い方の簡単な一例としてサンプルコードをみてください。

サンプルコードを実行する際には次のメンバをInspectorから設定してください。

Keysフィールド：辞書(_dictフィールド)に設定するキーの一覧。好きな数追加してください。
Textフィールド：画面に表示するために使うTextMeshコンポーネントをアタッチしてください。

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class Sample : MonoBehaviour {
  Dictionary<string, int> _dict;

  public List<string> Keys;
  public string ShowKey;
  public TextMesh Text;

  void Start() {
    //辞書の初期化。InspectorでKeysに設定したキーを追加している。
    _dict = new Dictionary<string, int>();
    for(var i=0; i<Keys.Count; ++i) {
      _dict.Add(Keys[i], (i+1) * 100);
    }
  }

  void Update() {
    if(Text == null) return; //Textが設定されていなかったら何もしない。

    //ShowKeyに設定されたキーが辞書にある場合はそのペアを、ない場合は何もないテキストを表示する。
    if(_dict.ContainsKey(ShowKey)) {
      Text.text = $"{ShowKey} => {_dict[ShowKey]}";
    } else {
      Text.text = "(none key...)";
    }
  }
}