From 0ac5c240f61d4e1bf797e14aa0c66ddda00140b3 Mon Sep 17 00:00:00 2001
From: MidoriKami <9083275+MidoriKami@users.noreply.github.com>
Date: Sat, 24 Jun 2023 23:36:58 -0700
Subject: [PATCH] Add IGameLifecycle (#1287)

---
 Dalamud/Game/GameLifecycle.cs             | 18 ++++++++---------
 Dalamud/Plugin/Services/IGameLifecycle.cs | 24 +++++++++++++++++++++++
 2 files changed, 32 insertions(+), 10 deletions(-)
 create mode 100644 Dalamud/Plugin/Services/IGameLifecycle.cs

diff --git a/Dalamud/Game/GameLifecycle.cs b/Dalamud/Game/GameLifecycle.cs
index 3a6733512..5c1acc989 100644
--- a/Dalamud/Game/GameLifecycle.cs
+++ b/Dalamud/Game/GameLifecycle.cs
@@ -2,6 +2,7 @@
 
 using Dalamud.IoC;
 using Dalamud.IoC.Internal;
+using Dalamud.Plugin.Services;
 
 namespace Dalamud.Game;
 
@@ -11,7 +12,10 @@ namespace Dalamud.Game;
 [PluginInterface]
 [InterfaceVersion("1.0")]
 [ServiceManager.BlockingEarlyLoadedService]
-public class GameLifecycle : IServiceType
+#pragma warning disable SA1015
+[ResolveVia<IGameLifecycle>]
+#pragma warning restore SA1015
+public class GameLifecycle : IServiceType, IGameLifecycle
 {
     private readonly CancellationTokenSource dalamudUnloadCts = new();
     private readonly CancellationTokenSource gameShutdownCts = new();
@@ -26,19 +30,13 @@ public class GameLifecycle : IServiceType
     {
     }
 
-    /// <summary>
-    /// Gets a token that is cancelled when Dalamud is unloading.
-    /// </summary>
+    /// <inheritdoc/>
     public CancellationToken DalamudUnloadingToken => this.dalamudUnloadCts.Token;
 
-    /// <summary>
-    /// Gets a token that is cancelled when the game is shutting down.
-    /// </summary>
+    /// <inheritdoc/>
     public CancellationToken GameShuttingDownToken => this.gameShutdownCts.Token;
 
-    /// <summary>
-    /// Gets a token that is cancelled when a character is logging out.
-    /// </summary>
+    /// <inheritdoc/>
     public CancellationToken LogoutToken => this.logoutCts.Token;
 
     /// <summary>
diff --git a/Dalamud/Plugin/Services/IGameLifecycle.cs b/Dalamud/Plugin/Services/IGameLifecycle.cs
new file mode 100644
index 000000000..caa64ed23
--- /dev/null
+++ b/Dalamud/Plugin/Services/IGameLifecycle.cs
@@ -0,0 +1,24 @@
+using System.Threading;
+
+namespace Dalamud.Plugin.Services;
+
+/// <summary>
+/// Class offering cancellation tokens for common gameplay events.
+/// </summary>
+public interface IGameLifecycle
+{
+    /// <summary>
+    /// Gets a token that is cancelled when Dalamud is unloading.
+    /// </summary>
+    public CancellationToken DalamudUnloadingToken { get; }
+    
+    /// <summary>
+    /// Gets a token that is cancelled when the game is shutting down.
+    /// </summary>
+    public CancellationToken GameShuttingDownToken { get; }
+
+    /// <summary>
+    /// Gets a token that is cancelled when a character is logging out.
+    /// </summary>
+    public CancellationToken LogoutToken { get; }
+}