lanlib/Scripts/Runtime/Singleton/README.md

![UnitySingleton](https://socialify.git.ci/labbbirder/UnitySingleton/image?description=1&font=Jost&forks=1&issues=1&name=1&stargazers=1&theme=Auto)


可以在Editor和Runtime混用的Unity单例模块。稳定可靠，懒加载，无额外开销，任何情况都不会出现多实例化。

![GitHub last commit](https://img.shields.io/github/last-commit/labbbirder/unitysingleton)
![GitHub package.json version](https://img.shields.io/github/package-json/v/labbbirder/unitysingleton)
[![openupm](https://img.shields.io/npm/v/com.bbbirder.singleton?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.bbbirder.singleton/)

## Features
* 兼容所有场景，稳定可靠的提供一个单例：
    * Editor和Runtime混合使用
    * 中途重新编译脚本
    * 不同的`Reload Domain`选项
    * 场景切换
    * etc
* 可以包含子物体：基于MonoBehaviour，可添加子GameObject
* 独立于场景：单例默认使用HideFlags隐藏，不属于任何场景，不需要考虑入口场景
* 可检索：可视化窗口检索单例列表（Window/bbbirder/Singletons）
## Basic Usage
只需要继承`Singleton<T>`
```csharp
using UnityEngine;
using com.bbbirder.unity;
public class YourComponent:Singleton<YourComponent>{
    protected override void Awake(){
        SayHello();
    }
    public void SayHello(){
        print("hello,world");
    }
}
```
需要调用的地方 ：
```csharp
    YourComponent.Instance.SayHello();
```
通过Window/bbbirder/Singletons窗口查看当前的单例

![窗口截图](Documentation/img_record.png)

## More Controls
### 指定实例化时机
```csharp
[assembly: SingletonAutoLoad(typeof(Manager))]
public class Manager:Singleton<Manager>{ //Manager 将会自动实例化

}
```
SingletonAutoLoadAttribute接收2个参数：
* 目标单例类型
* 实例化时机 enum `SingletonCreateCondition`
    * `LazyLoad` 懒加载，通过Instance获取时才实例化。无`SingletonAutoLoad`属性时默认模式
    * `DomainReload` 即时加载，在脚本开始运行前实例化。`SingletonAutoLoad`缺省选项
    * `EnterPlay` 进入播放模式加载

> 使用形如`[assembly:]`的特性使得`SingletonAutoLoadAttribute`在内部检索所有单例类型时消耗小，且非常迅速。可以放心的在Runtime环境下使用此模块。
### 指定销毁时机
```csharp
public class Manager:Singleton<Manager>{
    public override SingletonDestroyCondition DestroyCondition => SingletonDestroyCondition.ExitEdit;
}
```
`SingletonDestroyCondition` 具有以下选项：
* Never 不自动销毁
* SceneUnload 场景卸载时
* ReloadDomain 脚本重加载时 (默认)
* ExitPlay 切出播放模式时
* ExitEdit 切出编辑模式时

### 自定义实例化方法
```csharp

public class TestSingleton : Singleton<TestSingleton>
{
    protected new static TestSingleton CreateInstance(){
        var go = Singleton<TestSingleton>.CreateInstance();
        go.name += " (Singleton)";
        return go;
    }
}

```