Popup ECS Refactor (#4692)

Content.Shared/Popups/SharedPopupExtensions.cs

@@ -0,0 +1,57 @@
+using Robust.Shared.GameObjects;
+using Robust.Shared.Map;
+
+namespace Content.Shared.Popups
+{
+    public static class SharedPopupExtensions
+    {
+        /// <summary>
+        ///     Pops up a message at the location of <see cref="source"/> for
+        ///     <see cref="viewer"/> alone to see.
+        /// </summary>
+        /// <param name="source">The entity above which the message will appear.</param>
+        /// <param name="viewer">The entity that will see the message.</param>
+        /// <param name="message">The message to show.</param>
+        public static void PopupMessage(this IEntity source, IEntity viewer, string message)
+        {
+            var popupSystem = EntitySystem.Get<SharedPopupSystem>();
+
+            popupSystem.PopupEntity(message, source.Uid, popupSystem.GetFilterFromEntity(viewer));
+        }
+
+        /// <summary>
+        ///     Pops up a message at the given entity's location for it alone to see.
+        /// </summary>
+        /// <param name="viewer">The entity that will see the message.</param>
+        /// <param name="message">The message to be seen.</param>
+        public static void PopupMessage(this IEntity viewer, string message)
+        {
+            viewer.PopupMessage(viewer, message);
+        }
+
+        /// <summary>
+        /// Makes a string of text float up from a location on a grid.
+        /// </summary>
+        /// <param name="coordinates">Location on a grid that the message floats up from.</param>
+        /// <param name="viewer">The client attached entity that the message is being sent to.</param>
+        /// <param name="message">Text contents of the message.</param>
+        public static void PopupMessage(this EntityCoordinates coordinates, IEntity viewer, string message)
+        {
+            var popupSystem = EntitySystem.Get<SharedPopupSystem>();
+            popupSystem.PopupCoordinates(message, coordinates, popupSystem.GetFilterFromEntity(viewer));
+        }
+
+        /// <summary>
+        ///     Makes a string of text float up from a client's cursor.
+        /// </summary>
+        /// <param name="viewer">
+        ///     The client attached entity that the message is being sent to.
+        /// </param>
+        /// <param name="message">Text contents of the message.</param>
+        public static void PopupMessageCursor(this IEntity viewer, string message)
+        {
+            var popupSystem = EntitySystem.Get<SharedPopupSystem>();
+            popupSystem.PopupCursor(message, popupSystem.GetFilterFromEntity(viewer));
+        }
+    }
+}

Content.Shared/Popups/SharedPopupSystem.cs

@@ -0,0 +1,97 @@
+using System;
+using Robust.Shared.GameObjects;
+using Robust.Shared.Map;
+using Robust.Shared.Player;
+using Robust.Shared.Serialization;
+
+namespace Content.Shared.Popups
+{
+    /// <summary>
+    ///     System for displaying small text popups on users' screens.
+    /// </summary>
+    public abstract class SharedPopupSystem : EntitySystem
+    {
+        /// <summary>
+        ///     Shows a popup on the users' cursors.
+        /// </summary>
+        /// <param name="message">The message to display.</param>
+        /// <param name="filter">Filter for the players that will see the popup.</param>
+        public abstract void PopupCursor(string message, Filter filter);
+
+        /// <summary>
+        ///     Shows a popup at a world location.
+        /// </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>
+        public abstract void PopupCoordinates(string message, EntityCoordinates coordinates, Filter filter);
+
+        /// <summary>
+        ///     Shows a popup above an entity.
+        /// </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>
+        public abstract void PopupEntity(string message, EntityUid uid, Filter filter);
+
+        /// <summary>
+        ///     Given an <see cref="IEntity"/>, returns a <see cref="Filter"/> that is either empty or contains the
+        ///     player attached to the entity.
+        /// </summary>
+        /// <remarks>Using this method is NOT recommended, please use one of the other methods instead.</remarks>
+        public abstract Filter GetFilterFromEntity(IEntity entity);
+    }
+
+    /// <summary>
+    ///     Common base for all popup network events.
+    /// </summary>
+    [Serializable, NetSerializable]
+    public abstract class PopupEvent : EntityEventArgs
+    {
+        public string Message { get; }
+
+        protected PopupEvent(string message)
+        {
+            Message = message;
+        }
+    }
+
+    /// <summary>
+    ///     Network event for displaying a popup on the user's cursor.
+    /// </summary>
+    [Serializable, NetSerializable]
+    public class PopupCursorEvent : PopupEvent
+    {
+        public PopupCursorEvent(string message) : base(message)
+        {
+        }
+    }
+
+    /// <summary>
+    ///     Network event for displaying a popup at a world location.
+    /// </summary>
+    [Serializable, NetSerializable]
+    public class PopupCoordinatesEvent : PopupEvent
+    {
+        public EntityCoordinates Coordinates { get; }
+
+        public PopupCoordinatesEvent(string message, EntityCoordinates coordinates) : base(message)
+        {
+            Coordinates = coordinates;
+        }
+    }
+
+    /// <summary>
+    ///     Network event for displaying a popup above an entity.
+    /// </summary>
+    [Serializable, NetSerializable]
+    public class PopupEntityEvent : PopupEvent
+    {
+        public EntityUid Uid { get; }
+
+        public PopupEntityEvent(string message, EntityUid uid) : base(message)
+        {
+            Uid = uid;
+        }
+    }
+}