Cinka/OldThink
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Popup ECS Refactor (#4692)

Browse Source
This commit is contained in:
Vera Aguilera Puerto
2021-09-26 15:18:45 +02:00
committed by GitHub
parent 2051970cc1
commit 0767bd3777
142 changed files with 513 additions and 705 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Content.Shared/Interaction/SharedInteractionSystem.cs
View File

@@ -1,15 +1,13 @@
using System;
using System.Linq;
using Content.Shared.Notification;
using Content.Shared.Notification.Managers;
using Content.Shared.Physics;
using Content.Shared.Popups;
using JetBrains.Annotations;
using Robust.Shared.GameObjects;
using Robust.Shared.IoC;
using Robust.Shared.Localization;
using Robust.Shared.Map;
using Robust.Shared.Physics;
using Robust.Shared.Physics.Broadphase;
using Robust.Shared.Serialization;
namespace Content.Shared.Interaction
@@ -21,6 +19,7 @@ namespace Content.Shared.Interaction
public abstract class SharedInteractionSystem : EntitySystem
{
[Dependency] private readonly SharedBroadphaseSystem _sharedBroadphaseSystem = default!;
[Dependency] private readonly SharedPopupSystem _popupSystem = default!;
public const float InteractionRange = 2;
public const float InteractionRangeSquared = InteractionRange * InteractionRange;

86
Content.Shared/Notification/Managers/ISharedNotifyManager.cs
View File

@@ -1,86 +0,0 @@
using Robust.Shared.GameObjects;
using Robust.Shared.IoC;
using Robust.Shared.Map;
namespace Content.Shared.Notification.Managers
{
/// <summary>
/// Allows the ability to create floating text messages at locations in the world.
/// </summary>
public interface ISharedNotifyManager
{
/// <summary>
/// Makes a string of text float up from an entity.
/// </summary>
/// <param name="source">The entity that the message is floating 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>
void PopupMessage(IEntity source, IEntity viewer, string 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>
void PopupMessage(EntityCoordinates coordinates, IEntity viewer, string message);
/// <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>
void PopupMessageCursor(IEntity viewer, string message);
}
public static class SharedNotifyExtensions
{
/// <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 notifyManager = IoCManager.Resolve<ISharedNotifyManager>();
notifyManager.PopupMessage(source, viewer, message);
}
/// <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 notifyManager = IoCManager.Resolve<ISharedNotifyManager>();
notifyManager.PopupMessage(coordinates, viewer, message);
}
/// <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 notifyManager = IoCManager.Resolve<ISharedNotifyManager>();
notifyManager.PopupMessageCursor(viewer, message);
}
}
}

73
Content.Shared/Notification/Managers/SharedNotifyManager.cs
View File

@@ -1,73 +0,0 @@
using Lidgren.Network;
using Robust.Shared.GameObjects;
using Robust.Shared.Map;
using Robust.Shared.Network;
namespace Content.Shared.Notification.Managers
{
public abstract class SharedNotifyManager : ISharedNotifyManager
{
public abstract void PopupMessage(IEntity source, IEntity viewer, string message);
public abstract void PopupMessage(EntityCoordinates coordinates, IEntity viewer, string message);
public abstract void PopupMessageCursor(IEntity viewer, string message);
protected class MsgDoNotifyCursor : NetMessage
{
public override MsgGroups MsgGroup => MsgGroups.Command;
public string Message { get; set; } = string.Empty;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
Message = buffer.ReadString();
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
buffer.Write(Message);
}
}
protected class MsgDoNotifyCoordinates : NetMessage
{
public override MsgGroups MsgGroup => MsgGroups.Command;
public string Message { get; set; } = string.Empty;
public EntityCoordinates Coordinates;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
Message = buffer.ReadString();
Coordinates = buffer.ReadEntityCoordinates();
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
buffer.Write(Message);
buffer.Write(Coordinates);
}
}
protected class MsgDoNotifyEntity : NetMessage
{
public override MsgGroups MsgGroup => MsgGroups.Command;
public string Message { get; set; } = string.Empty;
public EntityUid Entity;
public override void ReadFromBuffer(NetIncomingMessage buffer)
{
Message = buffer.ReadString();
Entity = buffer.ReadEntityUid();
}
public override void WriteToBuffer(NetOutgoingMessage buffer)
{
buffer.Write(Message);
buffer.Write(Entity);
}
}
}
}

57
Content.Shared/Popups/SharedPopupExtensions.cs Normal file
View File

@@ -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));
}
}
}

97
Content.Shared/Popups/SharedPopupSystem.cs Normal file
View File

@@ -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;
}
}
}