生命周期事件参考

本文列出 RitsuLib 提供的全部生命周期事件，介绍订阅方式及可重放事件的行为。

订阅方式

按类型订阅（推荐）

var sub = RitsuLibFramework.SubscribeLifecycle<GameReadyEvent>(evt =>
{
    Logger.Info($"游戏已就绪：{evt.Game}");
});

// 取消订阅
sub.Dispose();

通过 ILifecycleObserver 订阅多种事件

public class MyObserver : ILifecycleObserver
{
    public void OnEvent(IFrameworkLifecycleEvent evt)
    {
        if (evt is CombatStartingEvent combat)
            HandleCombatStart(combat);
        else if (evt is RunEndedEvent run)
            HandleRunEnd(run);
    }
}

RitsuLibFramework.SubscribeLifecycle(new MyObserver());

可重放事件（IReplayableFrameworkLifecycleEvent）： 若在事件已发生后才订阅，框架会立即以已存储的事件实例回调，无需关心订阅时机。

---

框架事件

事件	可重放	携带数据
FrameworkInitializingEvent	—	FrameworkModId、FrameworkVersion
FrameworkInitializedEvent	✓	FrameworkModId、IsActive
ProfileServicesInitializingEvent	—	—
ProfileServicesInitializedEvent	✓	ProfileId

---

游戏引导事件

事件	可重放	携带数据
EssentialInitializationStartingEvent	—	—
EssentialInitializationCompletedEvent	✓	—
DeferredInitializationStartingEvent	—	—
DeferredInitializationCompletedEvent	✓	—
ContentRegistrationClosedEvent	✓	Reason
ModelRegistryInitializingEvent	—	—
ModelRegistryInitializedEvent	✓	RegisteredModelTypeCount
ModelIdsInitializingEvent	—	—
ModelIdsInitializedEvent	✓	—
ModelPreloadingStartingEvent	—	—
ModelPreloadingCompletedEvent	✓	—
GameTreeEnteredEvent	✓	Game
GameReadyEvent	✓	Game

RitsuLibFramework.SubscribeLifecycle<ModelIdsInitializedEvent>(_ =>
{
    var id = ModelDb.GetId<MyCard>();
});

---

跑局事件

事件	可重放	携带数据
RunStartedEvent	—	RunState、IsMultiplayer、IsDaily
RunLoadedEvent	—	RunState、IsMultiplayer、IsDaily
RunEndedEvent	—	Run、IsVictory、IsAbandoned

---

房间与章节事件

事件	携带数据
RoomEnteringEvent	RunState、Room
RoomEnteredEvent	RunState、Room
RoomExitedEvent	RunManager、Room
ActEnteringEvent	RunManager、TargetActIndex、DoTransition
ActEnteredEvent	RunState、CurrentActIndex
RewardsScreenContinuingEvent	RunManager

---

战斗事件

事件	携带数据
CombatStartingEvent	RunState、CombatState?
CombatEndedEvent	RunState、CombatState?、Room
CombatVictoryEvent	RunState、CombatState?、Room
SideTurnStartingEvent	CombatState、Side
SideTurnStartedEvent	CombatState、Side
CardPlayingEvent	CombatState、CardPlay
CardPlayedEvent	CombatState、CardPlay
CardDrawnEvent	CombatState、Card、FromHandDraw
CardDiscardedEvent	CombatState、Card
CardExhaustedEvent	CombatState、Card、CausedByEthereal
CardRetainedEvent	CombatState、Card
CardMovedBetweenPilesEvent	RunState、CombatState?、Card、PreviousPile、Source

生物事件

事件	携带数据
CreatureDyingEvent	CombatState、Creature
CreatureDiedEvent	CombatState、Creature

RitsuLibFramework.SubscribeLifecycle<CardDrawnEvent>(evt =>
{
    if (evt.Card is MyCard myCard)
        myCard.OnDrawn(evt.CombatState);
});

---

奖励事件

事件	携带数据
GoldGainedEvent	Amount
GoldLostEvent	Amount
PotionProcuredEvent	Potion
PotionDiscardedEvent	Potion
RelicObtainedEvent	Relic
RelicRemovedEvent	Relic
RewardTakenEvent	Reward

---

解锁事件

事件	携带数据
EpochObtainedEvent	Epoch
EpochRevealedEvent	Epoch
UnlockIncrementedEvent	UnlockState

---

存档与持久化事件

Profile 生命周期

事件	携带数据
ProfileIdInitializedEvent	ProfileId
ProfileSwitchingEvent	OldProfileId、NewProfileId
ProfileSwitchedEvent	ProfileId
ProfileDeletingEvent	ProfileId
ProfileDeletedEvent	ProfileId

存档写入

事件	携带数据
RunSavingEvent	RunState
RunSavedEvent	RunState
ProgressSavingEvent	—
ProgressSavedEvent	—

ModDataStore 数据事件

事件	说明
ProfileDataReadyEvent	存档数据加载完毕，可安全读写
ProfileDataChangedEvent	存档数据发生变更
ProfileDataInvalidatedEvent	存档数据失效（如切换档案）

---

游戏结算事件

事件	携带数据
GameOverScreenCreatedEvent	Screen

---