@umm/cafu_generics NPM

CAFU Generics

npm install github:umm-projects/cafu_generics

作成したいデータの構造に合わせて Entity を作成する
- Unity の Serializer の制約上、Generics を用いたクラスはシリアライズできないため、 GenericEntity<> などを継承したクラスを作る必要がある
通常のクラス用と、ScriptableObject 用の2種類がある
- 違いは、ScriptableObject を継承しているかどうかのみ

Key Value のペアを管理するための Entity
基本的には疑似 Dictionary の一要素としての定義を行う
- class HogeSpriteEntity : GenericPairEntity<HogeType, Sprite> などと定義することで、 HogeType の値に応じた Sprite のマップの一要素を作ることができる

GenricEntity をリストとして内包する Entity
- 紛らわしいが、値の型制約として IGenericEntity 型に限定している
定数 Entity の一覧から値を取得するなどの場合に用いる
- 一応用意しているが、あまり使うコトは無さそう
GetChildEntity(Func<TGenericEntity, bool> predicate) という子要素を検索するための拡張メソッドも生やしてある

GenericPairEntity をリストとして内包する Entity
- 紛らわしいが、値の型制約として IGenericPairEntity 型に限定している
疑似 Dictionary を作る場合などに用いる
- 恐らく最も利用する頻度の高い Entity
GetChildEntity(TKey key) という子要素を検索するための拡張メソッドも生やしてある

Entity を保持管理するためのクラス
Scene 上の任意の GameObject に AddComponent し、シーン内で読み込みたい Entity を登録していく
- GameObject 名は何でも良いが DataStore としておくと見通しが良い
- Scriptable Object Generic Entity List というフィールドが Inspector 上に生えているので、そこに ScriptableObject を D&D する
GetEntity<TGenericEntity>() メソッドで Entity のインスタンスを返す

Method Signature	Description
`TState GetCurrent()`	現在の値を取得
`void Change(TState state, bool forceNotify = false)`	状態を変更第二引数に真を渡すと、値が変更されていなくても `OnChangeAsObservable` に値を流す（内部的には ReactiveProperty.SetValueAndForceNotify）を実行している
`void Reset()`	値を初期値に戻す
`void Next()`	値を一つ進める`dynamic` による加算を行っているため、 `+` オペレータを解釈できない型の場合 Exception を吐く
`void Previous()`	値を一つ戻す`dynamic` による減算を行っているため、 `-` オペレータを解釈できない型の場合 Exception を吐く
`IObservable<TState> OnChangeAsObservable()`	値の変更を通知するストリームを構築
`IObservable<Unit> OnChangeAsObservable(TState state)`	値が第一引数の値になったコトを通知するストリームを構築