カスタム構成

構成オブジェクトは、サービスやその他のエンジンシステムを初期化および構成するために使用されます。

デフォルトでは、構成オブジェクトはScriptableObjectアセットとしてシリアル化され、プロジェクトの NaninovelData/Resources/Naninovel/Configuration に保存されます。Unityエディターで対応する構成メニュー（Naninovel -> Configuration）を初めて開いたときに、アセットが自動的に生成されます。

C#を介して構成オブジェクトにアクセスするには、Engine.GetConfiguration<T>() を使用します。ここで T は、アクセスする構成オブジェクトの型です。たとえば、次の例はオーディオ構成オブジェクトにアクセスする方法を示しています。

var audioConfig = Engine.GetConfiguration<AudioConfiguration>();

注意

エンジンの初期化手順は非同期であるため、自動初期化が有効になっている場合でも、Unityがシーンをロードした直後（たとえば、Awake、Start、OnEnable MonoBehaviour ↗ メソッド内）にエンジンAPI（GetConfiguration など）が利用できない場合があります。詳細については、エンジンAPIへのアクセスを参照してください。

Engine.GetConfiguration を使用するにはエンジンが初期化されている必要がありますが（構成プロバイダーに依存するため）、エンジンが初期化されていない場合でも、デフォルトのプロバイダーを介して直接構成アセットにアクセスできます。例：

var config = ProjectConfigurationProvider.LoadOrDefault<AudioConfiguration>();

構成オブジェクトはエディターメニューを介して変更することを意図していますが、実行時に変更することも可能です。デフォルトのプロジェクトプロバイダーによって返されるオブジェクトは、プロジェクトに保存されている実際のアセットであることに注意してください。プレイモードで変更すると、その変更はアセットに永続化されます。この点は、Engine.GetConfiguration によって返されるインスタンスとは異なります。こちらはランタイムインスタンスであり、元のアセットを変更しません。

以下は、エンジンの初期化直後にカメラ構成の ReferenceResolution プロパティを変更する例です。

using Naninovel;
using UnityEngine;

public static class ModifyConfigAtRuntime
{
    [RuntimeInitializeOnLoadMethod]
    private static void ModifyConfig ()
    {
        if (Engine.Initialized) OnInitializationFinished();
        else Engine.OnInitializationFinished += OnInitializationFinished;

        void OnInitializationFinished ()
        {
            Engine.OnInitializationFinished -= OnInitializationFinished;

            var cameraConfig = Engine.GetConfiguration<CameraConfiguration>();
            cameraConfig.ReferenceResolution = new Vector2Int(3840, 2160);
        }
    }
}

注意

Naninovelは、エンジンが初期化済みの状態で構成が変更されることを想定していないため、一部の変更を有効にするには、ProjectConfigurationProvider またはカスタムプロバイダーを使用して、エンジンを初期化する前に変更を適用する必要がある場合があります。

構成の追加

新しいカスタム構成を追加するには、Configuration を継承するC#クラスを作成します。

[EditInProjectSettings]
public class MyCustomConfiguration : Configuration
{
    [Header("My Custom Header 1")]
    [Tooltip("Tooltip for my custom string.")]
    public string MyCustomString = "Default value";
    [Range(0, 100), Tooltip("Tooltip for my custom float.")]
    public float MyCustomFloat = 10;

    [Header("My Custom Header 2")]
    public int[] MyCustomArray;
}

EditInProjectSettings 属性に注目してください。この属性を適用すると、対応するエディターメニューがプロジェクト設定に自動的に追加され、そこで組み込みメニューと同様にカスタム構成アセットのシリアル化可能なプロパティを変更できます。

C#を介してカスタム構成にアクセスするには、組み込みアセットと同じAPIを使用します。

var myConfig = Engine.GetConfiguration<MyCustomConfiguration>();

例

インベントリシステムをセットアップするためのカスタム構成メニューを追加する別の例は、インベントリサンプルにあります。具体的には、カスタム構成は Scripts/Runtime/Inventory/InventoryConfiguration.cs に実装されています。

カスタム構成のエディター上の動作（Naninovelのプロジェクト設定で描画されるときの動作）をカスタマイズするには、エディタースクリプトとしてクラスを作成し、ConfigurationSettings<T> を継承します。ここで T はカスタム構成の型です。独自のエディターを作成する際の参考として、Naninovel/Editor/Editors/Settings に保存されている組み込みの設定エディタースクリプトを使用できます。

組み込みエディターのオーバーライド

OverrideSettings 属性を ConfigurationSettings<T>（またはその派生クラス）から継承したエディタークラスに適用することで、組み込み構成エディター（Naninovelのプロジェクト設定メニュー）をオーバーライドできます。ここで T は構成の型です。カスタムエディタースクリプトは、エディターアセンブリに含まれるように「Editor」フォルダーの下に保存します。

以下は、組み込みのキャラクターマネージャー構成エディターをオーバーライドする例です。新しいエディターは、Shared Poses フィールドの下に共有ポーズの総数を示すラベルを追加します。

[OverrideSettings]
public class CustomCharacterSettings : CharactersSettings
{
    protected override Dictionary<string, Action<SerializedProperty>>
        OverrideConfigurationDrawers ()
    {
        var drawers = base.OverrideConfigurationDrawers();
        drawers[nameof(CharactersConfiguration.SharedPoses)] = property => {
            ActorPosesEditor.Draw(property);
            EditorGUILayout.LabelField(
                $"Number of shared poses is {property.arraySize}.");
        };
        return drawers;
    }
}

上記のエディターを使用すると、キャラクター構成は次のように描画されます。

組み込みのアクターメタデータエディターをオーバーライドすることもできます。以下のコードは、編集中のアクターの Message Color フィールドの下に、アクターの表示名と色の値を示すラベルを挿入します。

[OverrideSettings]
public class CustomCharacterSettings : CharactersSettings
{
    protected override MetadataEditor<ICharacterActor,
        CharacterMetadata> MetadataEditor { get; } = new MetaEditor();

    private class MetaEditor : CharacterMetadataEditor
    {
        protected override Action<SerializedProperty>
            GetCustomDrawer (string propertyName)
        {
            if (propertyName == nameof(CharacterMetadata.MessageColor))
                return property => {
                    EditorGUILayout.PropertyField(property);
                    EditorGUILayout.LabelField($"Message color of " +
                        $"'{Metadata.DisplayName}' is '{property.colorValue}'.");
                };
            return base.GetCustomDrawer(propertyName);
        }
    }
}

— 結果は次のようになります。

構成プロバイダー

実行時に構成オブジェクトを提供する方法を変更できます。たとえば、静的なプロジェクトアセットの代わりに、リモートホストに保存されたJSONファイルから構成を読み取ることができます。

構成の提供方法をカスタマイズするには、IConfigurationProvider を実装するC#クラスを作成します。このインターフェースには、Type 引数を受け取り、Configuration オブジェクトを返すメソッドが1つあります。要求された構成オブジェクトをどのように構築して値を設定するかは自由です。返すオブジェクトの型が要求された型と一致するようにしてください。

以下は、デフォルトの構成オブジェクトを返すカスタムプロバイダー実装の例です。

public class CustomConfigurationProvider : IConfigurationProvider
{
    public Configuration GetConfiguration (System.Type type)
    {
        var defaultAsset = ScriptableObject.CreateInstance(type);
        return defaultAsset as Configuration;
    }
}

次の例では、プロジェクトのキャラクター構成をオーバーライドし、実行時にメタデータを注入します。

public class CustomConfigurationProvider : ProjectConfigurationProvider
{
    public override Configuration GetConfiguration (System.Type type)
    {
        // キャラクター以外のすべてのプロジェクト構成をそのまま返します。
        if (type != typeof(CharactersConfiguration))
            return base.GetConfiguration(type);

        // キャラクターのメタデータを注入（またはオーバーライド）します。
        // 実際のデータは実行時に外部ソースを介して取得できます。
        var charsConfig = (CharactersConfiguration)base.GetConfiguration(type);
        charsConfig.Metadata["NewCustomChar"] = new CharacterMetadata {
            Implementation = typeof(NarratorCharacter).AssemblyQualifiedName,
            DisplayName = "Custom Narrator",
            UseCharacterColor = true,
            MessageColor = Color.cyan,
            // など...
        };

        // 変更を加えたキャラクター構成を返します。
        return charsConfig;
    }
}

カスタム構成プロバイダーの準備ができたら、エンジンの初期化を行うカスタムスクリプトを作成して、組み込みのものの代わりにそれを使用するようにエンジンに指示します。デフォルトでは、エンジンは Naninovel/Runtime/Engine/RuntimeInitializer.cs を介して初期化されます。参考として自由に使用してください。

あるいは、カスタム構成プロバイダーを使用したいだけで、エンジンの初期化ルーチンはデフォルトのまま維持したい場合は、オプションの構成プロバイダー引数を受け取る RuntimeInitializer.Initialize(IConfigurationProvider) の使用を検討してください。

public class CustomInitializer
{
    [RuntimeInitializeOnLoadMethod]
    private static void InitializeWithCustomProvider ()
    {
        var customProvider = new CustomConfigurationProvider();
        RuntimeInitializer.Initialize(customProvider).Forget();
    }
}

どちらの初期化方法を選択する場合でも、デフォルトの初期化手順が実行されないように、エンジン構成メニューで Initialize On Application Load を無効にしてください。

カスタム構成 ​

構成の追加 ​

組み込みエディターのオーバーライド ​

構成プロバイダー ​

カスタム構成

構成の追加

組み込みエディターのオーバーライド

構成プロバイダー