From: miniduikboot <mini@duikbo.at>
Date: Thu, 25 Jul 2024 17:08:34 +0000 (+0200)
Subject: Make Start/Finish GameData API public
X-Git-Tag: v1.10.0~15
X-Git-Url: https://git.deb.at/?a=commitdiff_plain;h=b26f451a07b002fba484a5435472c16345db7065;p=rhonda%2Fimpostor.git

Make Start/Finish GameData API public
---

diff --git a/src/Impostor.Api/Games/IGame.cs b/src/Impostor.Api/Games/IGame.cs
index 05d6015..71c764a 100644
--- a/src/Impostor.Api/Games/IGame.cs
+++ b/src/Impostor.Api/Games/IGame.cs
@@ -101,22 +101,41 @@ namespace Impostor.Api.Games
         /// <returns>A <see cref="ValueTask" /> representing the asynchronous operation.</returns>
         ValueTask SendToAsync(IMessageWriter writer, int id);
 
+        /// <summary>
+        ///     Start a GameData(To) message.
+        /// </summary>
+        /// <remarks>Use with caution, recommended only for advanced developers.</remarks>
+        /// <param name="targetClientId">The client to target if needed, `null` if the message should be sent to all players.</param>
+        /// <param name="type">Message type of the message.</param>
+        /// <returns>A <see cref="IMessageWriter" /> that you can fill and send using <see cref="FinishGameDataAsync"/>.</returns>
+        IMessageWriter StartGameData(int? targetClientId = null, MessageType type = MessageType.Reliable);
+
+        /// <summary>
+        ///     Finishes GameData message and sends it to either the target or all players.
+        /// </summary>
+        /// <remarks>Use with caution, recommended only for advanced developers.</remarks>
+        /// <param name="writer">MessageWriter received from <see cref="StartGameData"/>.</param>
+        /// <param name="targetClientId">Same target ClientId passed to StartGameData.</param>
+        /// <returns>Task that sends the packet.</returns>
+        ValueTask FinishGameDataAsync(IMessageWriter writer, int? targetClientId = null);
+
         /// <summary>
         ///     Creates a MessageWriter with GameData header.
         /// </summary>
         /// <remarks>Use with caution, recommended only for advanced developers.</remarks>
         /// <param name="targetNetId">Net id of the InnerNetObject.</param>
         /// <param name="callId">Rpc id of the message.</param>
-        /// <param name="targetClientId">Client id of GameDataTo's target.</param>
+        /// <param name="targetClientId">The client to target if needed, `null` if the message should be sent to all players.</param>
         /// <param name="type">Message type of the message.</param>
         /// <returns>A <see cref="IMessageWriter" /> that you can fill with rpc data and send using <see cref="FinishRpcAsync"/>.</returns>
-        IMessageWriter StartRpc(uint targetNetId, RpcCalls callId, int? targetClientId, MessageType type = MessageType.Reliable);
+        IMessageWriter StartRpc(uint targetNetId, RpcCalls callId, int? targetClientId = null, MessageType type = MessageType.Reliable);
 
         /// <summary>
-        /// Finishes rpc message and sends it to the target.
+        /// Finishes rpc message and sends it to either the target or all players.
         /// </summary>
+        /// <remarks>Use with caution, recommended only for advanced developers.</remarks>
         /// <param name="writer">Message writer of the rpc.</param>
-        /// <param name="targetClientId">Id of the receiving client.</param>
+        /// <param name="targetClientId">Same target client id passed to <see cref="StartRpc"/>.</param>
         /// <returns>A <see cref="ValueTask" /> representing the asynchronous operation.</returns>
         ValueTask FinishRpcAsync(IMessageWriter writer, int? targetClientId = null);
     }
diff --git a/src/Impostor.Server/Net/State/Game.Outgoing.cs b/src/Impostor.Server/Net/State/Game.Outgoing.cs
index 47aa9e9..4c2f31f 100644
--- a/src/Impostor.Server/Net/State/Game.Outgoing.cs
+++ b/src/Impostor.Server/Net/State/Game.Outgoing.cs
@@ -55,11 +55,7 @@ namespace Impostor.Server.Net.State
             return FinishGameDataAsync(writer, targetClientId);
         }
 
-        /// <summary>Start a GameData(To) message.</summary>
-        /// <param name="targetClientId">The client to target if needed, `null` otherwise.</param>
-        /// <param name="type">The type of message to send, defaults to reliable.</param>
-        /// <returns>MessageWriter that should be handed back to <see cref="FinishGameDataAsync"/>.</returns>
-        private IMessageWriter StartGameData(int? targetClientId = null, MessageType type = MessageType.Reliable)
+        public IMessageWriter StartGameData(int? targetClientId = null, MessageType type = MessageType.Reliable)
         {
             var writer = MessageWriter.Get(type);
 
@@ -78,11 +74,7 @@ namespace Impostor.Server.Net.State
             return writer;
         }
 
-        /// <summary>Finalize and send a GameData packet.</summary>
-        /// <param name="writer">MessageWriter received from <see cref="StartGameData"/>.</param>
-        /// <param name="targetClientId">Same target ClientId passed to StartGameData.</param>
-        /// <returns>Task that sends the packet.</returns>
-        private ValueTask FinishGameDataAsync(IMessageWriter writer, int? targetClientId = null)
+        public ValueTask FinishGameDataAsync(IMessageWriter writer, int? targetClientId = null)
         {
             writer.EndMessage();