【Unity / プログラミング】Enumの拡張機能を使おう！

今回はUnityでEnumに拡張機能を持たせることができるらしいので記事を書いてみました。
Enumに関連する処理をまとめて処理することでコードが綺麗になるのでぜひ活用してみてくださいね。

Enum拡張とは

スクリプトを書かれている方にはお馴染みのタイプや種類を定義する時に利用する「Enum」。

実装する時にクラスに関数を用意してそこでタイプごとに処理をすることって多いと思います。そんな時に知ってると便利な機能「Enum拡張機能」について紹介したいと思います！

 

キャラクタータイプでのEnum例

例えばキャラクターの種類（タイプ）であれば人間、鳥、動物などのタイプがあったとすると共通してこんな関数が作りたくなることがありますよね。

bool IsFlying() // 飛んでいるか

これは文字通り飛行するタイプのキャラクターかを識別するためのクラス内の関数となります。

そしてこの関数でタイプ別に「飛行しているか」判定するためには
下記のように書くことが多いと思います。

public enum CharacterType{
    Human,
    Bird,
    Animal,
}

public class Character
{
    CharacterType characterType;

    public bool IsFlying()
    {
        switch(characterType)
        {
            case CharacterType.Human:
            case CharacterType.Animal:
                return false;
            case CharacterType.Bird:
                return true;
        }
        return false;
    }
}

ただこの実装には少しあまり良くない点もあります。

 

実装の問題点

さきほどの実装だとEnum自体の処理(鳥は飛べる、人は飛べないなど)がCharacterというクラスに依存する形になっていて、Characterクラスがないとこの処理を呼べなくなってしまいます。

ほかにも

といったデメリットがあったりします。

そして、それを改善するために
今回お伝えする「Enumの拡張機能」がとても便利だったりします。

 

Enum拡張機能の実装方法

では実際に拡張機能を実装していきたいと思います。

 

「すでにある関数」を拡張側に移行

ではまず先ほど用意した「IsFlying」という判定処理を拡張機能に移行してみます。

public enum CharacterType{
    Human,
    Bird,
    Animal,
}
public static partial class EnumExtend
{
    public static bool IsFlying( this CharacterType characterType )
    {
        switch(characterType)
        {
            case CharacterType.Human:
            case CharacterType.Animal:
                return false;
            case CharacterType.Bird:
                return true;
        }
        return false;
    }
}

実装方法としては

となります。

 

Enum拡張した関数を呼ぶ

さっそく拡張した関数を呼んでみたいと思います。
呼び方は非常に簡単で下記のようになります。

characterType.IsFlying()

そして実際に呼び出し処理クラスに仮で入れてみるとこんな感じになります。

public class Character
{
    CharacterType characterType;

    void Update()
    {
        if(characterType.IsFlying())
        {
            // 飛んでいるキャラの処理
        }
        else
        {
            // 飛んでないキャラの処理
        }
    }
}

処理としては「Update」内で飛行タイプのキャラクターとそうでないものを
分けているだけとなります。

 

活動内容のPR

下記が本サイトでの活動内容となります。

開発チャンネルを見る

 

最後に

いかがでしたでしょうか？

今回はEnumの拡張について紹介してみました。
これを使うことによってよりわかりやすくミスの少ないコードを作ることができそうです。

では今回は以上となります。
この度はここまでお読みいただきありがとうございました。

 

また本サイトではゲーム開発についての情報を発信しております。
もし興味がございましたら画面左下のベルマークからサイトを購読いただけますと幸いです。