126 lines
3.4 KiB
Markdown
126 lines
3.4 KiB
Markdown
# Unity SerializeReferenceExtensions
|
|
|
|
[](https://github.com/mackysoft/Unity-SerializeReferenceExtensions/actions/workflows/build.yaml)
|
|
[](https://github.com/mackysoft/Unity-SerializeReferenceExtensions/releases)
|
|
[](https://openupm.com/packages/com.mackysoft.serializereference-extensions/)
|
|
|
|
**Inspired by [this post](https://qiita.com/tsukimi_neko/items/7922b2433ed4d8616cce).**
|
|
|
|
The `SerializeReference` attribute, added in Unity 2019.3, makes it possible to serialize references to interfaces and abstract classes.
|
|
|
|
The `SubclassSelector` attribute allows you to easily set subclasses of those abstract classes in the Editor that are serialized by `SerializeReference` attribute.
|
|
|
|
|
|
|
|
#### Features
|
|
|
|
- Easily set subclass by popup.
|
|
- **[New]** Type finding by fuzzy finder.
|
|
- **[New]** Override the type name and path by the `AddTypeMenu` attribute.
|
|
|
|
## 📥 Installation
|
|
|
|
Download any version from releases.
|
|
|
|
Releases: https://github.com/mackysoft/Unity-SerializeReferenceExtensions/releases
|
|
|
|
#### Install via git URL
|
|
|
|
Or, you can add this package by opening PackageManager and entering
|
|
|
|
`https://github.com/mackysoft/Unity-SerializeReferenceExtensions.git?path=Assets/MackySoft/MackySoft.SerializeReferenceExtensions`
|
|
|
|
from the `Add package from git URL` option.
|
|
|
|
|
|
#### Install via Open UPM
|
|
|
|
Or, you can install this package from the [Open UPM](https://openupm.com/packages/com.mackysoft.serializereference-extensions/) registry.
|
|
|
|
More details [here](https://openupm.com/).
|
|
|
|
```
|
|
openupm add com.mackysoft.serializereference-extensions
|
|
```
|
|
|
|
## 🔰 Usage
|
|
|
|
```cs
|
|
using System;
|
|
using UnityEngine;
|
|
|
|
public class Example : MonoBehaviour {
|
|
|
|
// The type that implements ICommand will be displayed in the popup.
|
|
[SerializeReference, SubclassSelector]
|
|
ICommand m_Command;
|
|
|
|
// Collection support
|
|
[SerializeReference, SubclassSelector]
|
|
ICommand[] m_Commands = Array.Empty<ICommand>();
|
|
|
|
void Start () {
|
|
m_Command?.Execute();
|
|
|
|
foreach (ICommand command in m_Commands) {
|
|
command?.Execute();
|
|
}
|
|
}
|
|
|
|
// Nested type support
|
|
[Serializable]
|
|
public class NestedCommand : ICommand {
|
|
public void Execute () {
|
|
Debug.Log("Execute NestedCommand");
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
public interface ICommand {
|
|
void Execute ();
|
|
}
|
|
|
|
[Serializable]
|
|
public class DebugCommand : ICommand {
|
|
|
|
[SerializeField]
|
|
string m_Message;
|
|
|
|
public void Execute () {
|
|
Debug.Log(m_Message);
|
|
}
|
|
}
|
|
|
|
[Serializable]
|
|
public class InstantiateCommand : ICommand {
|
|
|
|
[SerializeField]
|
|
GameObject m_Prefab;
|
|
|
|
public void Execute () {
|
|
UnityEngine.Object.Instantiate(m_Prefab,Vector3.zero,Quaternion.identity);
|
|
}
|
|
}
|
|
|
|
// Menu override support
|
|
[AddTypeMenu("Example/Add Type Menu Command")]
|
|
[Serializable]
|
|
public class AddTypeMenuCommand : ICommand {
|
|
public void Execute () {
|
|
Debug.Log("Execute AddTypeMenuCommand");
|
|
}
|
|
}
|
|
```
|
|
|
|
#### Supported Types
|
|
|
|
The `SubclassSelector` attribute supports types that meet the following conditions.
|
|
|
|
- Class
|
|
- Public
|
|
- Not abstract
|
|
- Not generic
|
|
- Not unity object
|
|
- Serializable attribute is applied.
|