変数アセット

abstract

名前空間：SilCilSystem.Variables (ジェネリック版はSilCilSystem.Variables.Generic)

Assembly：SilCilSystem

異なるスクリプト間で変数の値を共有できます。値の変更が可能なVariable<T>と値の読み取りのみ可能なReadonlyVariable<T>が存在します。

クラス一覧

抽象クラス	役割
Variable<T>	ValueでT型の値のset/get
ReadonlyVariable<T>	ValueでT型の値のget

Unity2019ではジェネリッククラスをシリアライズすることができないため、よく使う型については非ジェネリックな抽象クラスを用意しています。実際のスクリプトでは以下のクラスを使用することになると思います。

Primitive

型	クラス	読取専用クラス
bool	VariableBool	ReadonlyBool
string	VariableString	ReadonlyString
int	VariableInt	ReadonlyInt
float	VariableFloat	ReadonlyFloat

UnityEngineのstruct型

型	クラス	読取専用クラス
Vector2	VariableVector2	ReadonlyVector2
Vector2Int	VariableVector2Int	ReadonlyVector2Int
Vector3	VariableVector3	ReadonlyVector3
Vector3Int	VariableVector3Int	ReadonlyVector3Int
Color	VariableColor	ReadonlyColor
Quaternion	VariableQuaternion	ReadonlyQuaternion

使用例

例えば、キーを押すたびに値が増えるカウンタを作ってみます。

using UnityEngine;
using SilCilSystem.Variables;

public class TestVariableInt : MonoBehaviour
{
    // 変数アセットをシリアライズしてインスペクタで設定可能に.
    [SerializeField] private VariableInt m_count = default;

    private void Update()
    {
        if (Input.anyKeyDown)
        {
            // キーを押すたびに値を1増やす.
            m_count.Value++;
        }
    }
}

カウンタの値をDebug.Logで表示することを考えます。値を読み取るだけで値の変更は行わないため、ReadonlyIntを使用します。

using UnityEngine;
using SilCilSystem.Variables;

public class TestReadonlyInt : MonoBehaviour
{
    // 変数アセットをシリアライズしてインスペクタで設定可能に.
    [SerializeField] private ReadonlyInt m_count = default;

    private void Update()
    {
        // 値を表示する. UpdateでDebug.Logすべきではないけど、サンプルなので許して.
        Debug.Log(m_count.Value);
    }
}

インスペクタ上で同じ変数を設定すれば、両者の連携が可能になります。メニューからint型の変数アセットを作成して設定します。

変数アセットをインスペクタ上で設定する

使用上の注意点

Updateで値をチェックして、値が変わったら何か処理をするといったことをしたい場合にはイベントアセットの使用を検討してください。値の変更が少ない場合には、イベントアセットで実現するほうが良いと思います。上記のカウンタの例もイベントアセットで実現できます。イベントを使用する場合はこちらが参考になります。

実装

Variable<T>は抽象クラスなので、具体的な実装を記述していません。インスペクタ上で設定するアセットはinternalクラスとして実装しています。

最も簡単な変数アセットの実装は変数を1つだけ持つ単純なScriptableObejctです。例えば、Variable<bool>を継承したクラスならこうなります。

// 使用する際は具体的な型（この場合はBoolValue）を知る必要がないのでinternalで実装.
internal class BoolValue : VariableBool
{
    [SerializeField] private bool m_value = default;
    public override bool Value { get => m_value; set => m_value = value; }
}

読み取り専用クラスの具体的な実装はVariableBoolを参照に持ち、値を返します。

internal class ReadonlyBoolValue : ReadonlyBool
{
    [SerializeField] private VariableBool m_variable = default;
    public override bool Value => m_variable.Value;
}