【Odin】リストの中身やクラスのフィールドが検索可能になる「Searchable」属性【Unity】

Odinで追加される「Searchable」属性を使用することで、リストの中身やクラスのフィールドが検索できるようになります。

使い方
1. リストに使用する方法
2. クラスに使用する方法
さいごに

使い方

リストに使用する方法

使い方は、string型のリストまたは配列に [Searchable] 属性をつけるだけです。

using System.Collections.Generic;
using Sirenix.OdinInspector;
using UnityEngine;

public class OdinSample : MonoBehaviour
{
    [Searchable]
    public List<string> items = new List<string>();
}

任意のクラス［構造体］のリストにもつけられます。

検索に適合するかどうかの判定を実装するには、クラスに「ISearchFilterable」を実装して、「FilterOptions」に「SearchFilterOptions.ISearchFilterableInterface」を指定します。

using System;
using System.Collections.Generic;
using Sirenix.OdinInspector;
using UnityEngine;

public class OdinSample : MonoBehaviour
{
    [Searchable(FilterOptions = SearchFilterOptions.ISearchFilterableInterface)]
    public List<Member> members = new List<Member>();

    [Serializable]
    public class Member : ISearchFilterable
    {
        public string name;
        public int age;
        
        public bool IsMatch(string searchString)
        {
            return name.IndexOf(searchString, StringComparison.OrdinalIgnoreCase) != -1;
        }
    }
}

クラスに使用する方法

クラス［構造体］に対して使うと、フィールドを検索できるようになります。

using System;
using Sirenix.OdinInspector;
using UnityEngine;

public class OdinSample : MonoBehaviour
{
    [Searchable] public Enemy enemy;
    
    [Serializable]
    public class Enemy
    {
        public string name;
        public int health;
        public int attack;
        public int defence;
    }
}

また、クラス［構造体］自体にもつけられます。

using System;
using Sirenix.OdinInspector;
using UnityEngine;

public class OdinSample : MonoBehaviour
{
    public Enemy enemy;
    
    [Serializable, Searchable]
    public class Enemy
    {
        public string name;
        public int health;
        public int attack;
        public int defence;
    }
}

もちろん、MonoBehaviourにもつけられます。

using Sirenix.OdinInspector;
using UnityEngine;

[Searchable]
public class OdinSample : MonoBehaviour
{
    public string name;
    public int health;
    public int attack;
    public int defence;
}