GameStateStructure

ゲームの大枠のステートを制御するライブラリです。遷移を属性で宣言的に記載することで、どのように遷移するのかを明示出来ます。

ステートを作成する

GameStateを継承して遷移を属性を立てて宣言します。

[GoTo(typeof(Root))]
[Push(typeof(Boot))]
class Root : GameState
{
	protected override void OnEnter()
	{
		// SrouceGeneratorで自動生成されます。
		PushBoot();
	}

	public void Reboot()
	{
		GoToRoot();
	}
}

[Push(typeof(Dialog))]
class Boot : GameState
{
	public async void OpenDialog()
	{
		await RunDialog("Message");
	}
}

class Dialog : GameState, IModal
{
	[Arg]
	string Message { get; set; }

	public async Task Run()
	{
		await OpenUI(Message);
	}
}

遷移の宣言

GoToは自身のステートを終了して指定のステートに遷移します。
Pushは子供として指定のステートを追加します。
どちらも宣言すると自動で遷移関数が生成されます。

引数に関して

ステートのプロパティにArg属性を設定すると遷移時の引数になります。

モーダル

IModalが追加ステートをプッシュする場合とモーダルとして他の遷移をロックをかけてRun関数を実行します。
IModal<TResult>を利用すると結果を受け取れます。

イベントを設定する

例えば親のステートの関数を呼びたい場合があります。その場合、組み込みイベントと使うことで手軽に実現出来ます。

イベントを受け取りたいインターフェースもしくはステートの関数にSubscribeEventを宣言します。
イベントを実行したい側はPublishEventで呼び出したいイベントを持つ型を指定します。

[SubscribeEvent]
interface IReboot
{
	void Reboot();
}

[GoTo(typeof(Root))]
class Root : GameState, IReboot
{
	void IReboot.Reboot()
	{
		GoToRoot();
	}
}

[PublishEvent(typeof(IReboot), Prefix = "Dispatch")]
class GameMain : GameState
{
	void GameOver()
	{
		// Prefix(Dispatch) + IReboot.Reboot
		DispatchReboot();
	}
}

ステートの共通処理を実装する

ステート間のフェードなどを実装するためにDecoratorという機能があります。ステート側のマーカー設定を見て実行されます。マーカーにはAttributeの場合はステートに設定されている属性を取得します。それ以外の場合はマーカーにキャスト可能の場合に実行されます。

public class FadeAttribute : Attribute {}

public class FadeDecorator : Decorator<FadeAttribute>
{
	IFader Fader { get; set; }

	Dictionary<object, FadeHandle> m_Dic = new();

	protected override async Task OnPreInitialize(GameState state, FadeAttribute maker)
	{
		var handle = m_Dic[state] = Fader.Out(new FadeConfig());
		_ = state.Context.Manage(handle);
		await handle;
	}

	protected override void OnPostEnter(GameState state, FadeAttribute maker)
	{
		if (m_Dic.TryGetValue(state, out var handle))
		{
			m_Dic.Remove(state);
			state.Context.Unmanage(handle);
			handle.Dispose();
		}
	}

}

yazawa-ichio / GameStateStructure