ゲーム開始時にScriptableObjectの初期化関数を実行する方法

Question

こんにちは。Unity初心者です。タイトルの通りなのですが、ゲーム開始時にScriptableObjectの初期化関数を実行したいのですがどうすればよいでしょうか？

ScriptableObjectはパラメータを保存することができますが、たとえばですがキャラクターの攻撃力をHPの1/10にしたいなど、パラメータそのものではなくパラメータを決める規則があるとします。その場合ゲーム開始時にパラメータを計算し、そのあとずっと求まった値を使いまわしたいと思うのですが、どうすればよいでしょうか？

ScriptableObjectのAwake関数がありますが、調べてみるとどうやらゲーム開始時に実行されるわけではないようなのです。以下のようにAwake関数を書いても、攻撃力はHPの1/10にはなりませんし、コンソール出力もありません。

public class Data : ScriptableObject
{
    public string name;
    public int HP;
    public int power;
        
　　public void Awake(){
        power = HP/10;
        Debug.Log("awake");
    } 
}　

よろしくお願いいたします。

Comments

[IShix]

DataクラスはInspectorからアタッチする想定ですか？

[segnana]

返信ありがとうございます。

そうです。[CreateAssetMenu(menuName = "Param/Data")]をスクリプトに書いて右クリック→Crate→Param→DataでAssetを生成し、それをGameObjectにアタッチしています。

Answer 1

ScriptableObjectのAwakeとOnEnableはMonoBehaviourのAwakeとOnEnableとでまったく異なるタイミングで走るのでまずその説明をさせてください。

MonoBehaviourとScriptableObject イベント関数の違い

ヒエラルキーに設置しているオブジェクト(MonoBehaviour)とアタッチしているScriptableObjectはゲーム(ランタイム)開始時に自動的に生成されると思ってください。

▼ MonoBehaviour
[Awake] ゲーム(ランタイム)中に生成された時1度だけ走る
[OnEnable] ゲーム(ランタイム)中に表示された時毎回走る(生成時やSetActive(true)した時)

▼ ScriptableObject
[Awake] 生成された時走る(クラスに[CreateAssetMenu]アトリビュートをアタッチし右クリック > Create > スクリプト名で生成する時や既に存在するScriptableObjectを複製した時スクリプトを修正した時)
[OnEnable] ゲーム(ランタイム)中初めて読み込まれた時に1度だけ走る

ScriptableObjectのAwakeのみランタイムは関係ありません。
生成後Project上に残り続けるデータだからです。メソッド名が同じなので混乱しますね。違う名前にして欲しかったです。

###今回の用件に合いそうなのはScriptableObject.OnEnable()
Awake()をOnEnable()に書き換えれば求める挙動になります。1つ訂正する点があるとすればpowerがScriptableObjectに書き込まれてしまうので下記のようにすると良いです。

using System;
using UnityEngine;

// 右クリックでScriptableObjectを生成できるようにする
[CreateAssetMenu(menuName = "ScriptableObject/Data")]
public class Data : ScriptableObject
{
    public string name;
    public int HP;

    // この変数は保存されないようにアトリビュートを追加
    [NonSerialized] public int power;

    public void OnEnable()
    {
        power = HP / 10;
        Debug.Log("awake");
    }
}

イベントの実行順

ヒエラルキーに設置したオブジェクト(MonoBehaviour)とアタッチしているScriptableObjectと想定すると下記の実行順となります。

1. ScriptableObject.OnEnable()
2. MonoBehaviour.Awake()
3. MonoBehaviour.OnEnable()
4. MonoBehaviour.Start()

今回詳しく解説した理由

今回のpowerは取得タイミングによって値が変わります。
OnEnableが走る前は0を返し、OnEnableが走った後は計算された値を返します。
こういうのをプログラム用語で「副作用がある」と言います。
今回の説明でOnEnableでpowerに代入すれば常に計算された値を取得できる事が保証されているのが分かると思います。
特に今回のような戻り値のあるもので副作用がある場合、バグになりやすいので徹底的に問題無いか調査するのをおすすめします。

Answer 2

ScriptableObjectのAwake関数がありますが、調べてみるとどうやらゲーム開始時に実行されるわけではないようなのです。以下のようにAwake関数を書いても、攻撃力はHPの1/10にはなりませんし、コンソール出力もありません。

ScriptableObject には Awake 関数というものはありません。質問のように Awake 関数を書いても、それはただ自分で勝手に宣言した Awake 関数であって、「そのスクリプトコンポーネントがアタッチされた GameObject がシーン上でインスタンス化する時に呼び出される」Awake 関数とはまったく関係ない、自分で勝手に作った単に同じ名前の関数であるだけです。

いつも使っている「勝手に呼び出されてくれる Awake 関数」は MonoBehaviour クラスのメンバ変数であり、MonoBehaviour クラスを継承した「GameObject にアタッチして実行するスクリプト コンポーネント」である場合のみ動作します。

• MonoBehaviour.Awake()

質問へのコメントで「アタッチ」という言葉を使っていますが、それらは「アサイン」ですね。アタッチとは異なる操作です。

ScriptableObjectはパラメータを保存することができますが、たとえばですがキャラクターの攻撃力をHPの1/10にしたいなど、パラメータそのものではなくパラメータを決める規則があるとします。

その場合は、ScriptableObject のアセットからデータを読み込んで値を求めて、MonoBehaviour を継承したクラス内のメンバ変数に保存します。

以下の記事も読むとよいでしょう。ScriptableObject で作ったものは「コンポーネント」ではなく「アセット」です。アセットの設定値（プロパティ）をゲーム実行中にスクリプトから変更してそれをアセットに保存することはできない、というのは Unity 全体で共通のルールです。

• 【Unity】ScriptableObjectってなんなん? って時に読む記事【解説】 -
  セーブデータを記録するのには使えない

Comments

[bboydaisuke]

間違いを書いてしまったので訂正します。

> ScriptableObject には Awake 関数というものはありません。...

ScriptableObject.Awake はありました。呼ばれるタイミングは ScriptableObject を使って作ったアセットがシーンにロードされた時です。
ref. https://docs.unity3d.com/ScriptReference/ScriptableObject.Awake.html

次のようなコードを書いて soArray に３つの Data アセットをアサインした場合、それぞれの Data オブジェクトに対してオブジェクトがロードされるたびに１度ずつ ScriptableObject.Awake() が呼ばれます。

using UnityEngine;

public class SO : MonoBehaviour
{
Data[] soArray;

void Start()
{
foreach(var so in soArray)
{

Debug.Log(so.HP);
Debug.Log(so.power);
}
}
}