PopupSystem public methods rejig (#12830)

Content.Shared/Popups/SharedPopupSystem.cs

@@ -1,5 +1,6 @@
 using Robust.Shared.Map;
 using Robust.Shared.Player;
+using Robust.Shared.Players;
 using Robust.Shared.Serialization;
 
 namespace Content.Shared.Popups
@@ -10,30 +11,77 @@ namespace Content.Shared.Popups
     public abstract class SharedPopupSystem : EntitySystem
     {
         /// <summary>
-        ///     Shows a popup on the users' cursors.
+        ///     Shows a popup at the local users' cursor. Does nothing on the server.
         /// </summary>
         /// <param name="message">The message to display.</param>
-        /// <param name="filter">Filter for the players that will see the popup.</param>
         /// <param name="type">Used to customize how this popup should appear visually.</param>
-        public abstract void PopupCursor(string message, Filter filter, PopupType type=PopupType.Small);
+        public abstract void PopupCursor(string message, PopupType type = PopupType.Small);
 
         /// <summary>
-        ///     Shows a popup at a world location.
+        ///     Shows a popup at a users' cursor.
+        /// </summary>
+        /// <param name="message">The message to display.</param>
+        /// <param name="recipient">Client that will see this popup.</param>
+        /// <param name="type">Used to customize how this popup should appear visually.</param>
+        public abstract void PopupCursor(string message, ICommonSession recipient, PopupType type = PopupType.Small);
+
+        /// <summary>
+        ///     Shows a popup at a users' cursor.
+        /// </summary>
+        /// <param name="message">The message to display.</param>
+        /// <param name="recipient">Client that will see this popup.</param>
+        /// <param name="type">Used to customize how this popup should appear visually.</param>
+        public abstract void PopupCursor(string message, EntityUid recipient, PopupType type = PopupType.Small);
+
+        /// <summary>
+        ///     Shows a popup at a world location to every entity in PVS range.
         /// </summary>
         /// <param name="message">The message to display.</param>
         /// <param name="coordinates">The coordinates where to display the message.</param>
-        /// <param name="filter">Filter for the players that will see the popup.</param>
         /// <param name="type">Used to customize how this popup should appear visually.</param>
-        public abstract void PopupCoordinates(string message, EntityCoordinates coordinates, Filter filter, PopupType type=PopupType.Small);
+        public abstract void PopupCoordinates(string message, EntityCoordinates coordinates, PopupType type = PopupType.Small);
 
         /// <summary>
-        ///     Shows a popup above an entity.
+        ///     Filtered variant of <see cref="PopupCoordinates(string, EntityCoordinates, PopupType)"/>, which should only be used
+        ///     if the filtering has to be more specific than simply PVS range based.
+        /// </summary>
+        /// <param name="filter">Filter for the players that will see the popup.</param>
+        /// <param name="recordReplay">If true, this pop-up will be considered as a globally visible pop-up that gets shown during replays.</param>
+        public abstract void PopupCoordinates(string message, EntityCoordinates coordinates, Filter filter, bool recordReplay, PopupType type = PopupType.Small);
+
+        /// <summary>
+        ///     Variant of <see cref="PopupCoordinates(string, EntityCoordinates, PopupType)"/> that sends a pop-up to the player attached to some entity.
+        /// </summary>
+        public abstract void PopupCoordinates(string message, EntityCoordinates coordinates, EntityUid recipient, PopupType type = PopupType.Small);
+
+        /// <summary>
+        ///     Variant of <see cref="PopupCoordinates(string, EntityCoordinates, PopupType)"/> that sends a pop-up to a specific player.
+        /// </summary>
+        public abstract void PopupCoordinates(string message, EntityCoordinates coordinates, ICommonSession recipient, PopupType type = PopupType.Small);
+
+        /// <summary>
+        ///     Shows a popup above an entity for every player in pvs range.
         /// </summary>
         /// <param name="message">The message to display.</param>
         /// <param name="uid">The UID of the entity.</param>
-        /// <param name="filter">Filter for the players that will see the popup.</param>
         /// <param name="type">Used to customize how this popup should appear visually.</param>
-        public abstract void PopupEntity(string message, EntityUid uid, Filter filter, PopupType type=PopupType.Small);
+        public abstract void PopupEntity(string message, EntityUid uid, PopupType type=PopupType.Small);
+
+        /// <summary>
+        ///     Variant of <see cref="PopupEntity(string, EntityUid, PopupType)"/> that shoes the popup only to some specific client.
+        /// </summary>
+        public abstract void PopupEntity(string message, EntityUid uid, EntityUid recipient, PopupType type = PopupType.Small);
+
+        /// <summary>
+        ///     Variant of <see cref="PopupEntity(string, EntityUid, PopupType)"/> that shoes the popup only to some specific client.
+        /// </summary>
+        public abstract void PopupEntity(string message, EntityUid uid, ICommonSession recipient, PopupType type = PopupType.Small);
+
+        /// <summary>
+        ///     Filtered variant of <see cref="PopupEntity(string, EntityUid, PopupType)"/>, which should only be used
+        ///     if the filtering has to be more specific than simply PVS range based.
+        /// </summary>
+        public abstract void PopupEntity(string message, EntityUid uid, Filter filter, bool recordReplay, PopupType type = PopupType.Small);
     }
 
     /// <summary>