Adds documentation to ISharedNotifyManager.

This commit is contained in:
Acruid
2020-06-17 18:19:31 -07:00
parent 56f9aa8122
commit 9b8cedf6c6

View File

@@ -1,13 +1,35 @@
using Robust.Shared.Interfaces.GameObjects; using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.IoC; using Robust.Shared.IoC;
using Robust.Shared.Map; using Robust.Shared.Map;
namespace Content.Shared.Interfaces namespace Content.Shared.Interfaces
{ {
/// <summary>
/// Allows the ability to create floating text messages at locations in the world.
/// </summary>
public interface ISharedNotifyManager 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); 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(GridCoordinates coordinates, IEntity viewer, string message); void PopupMessage(GridCoordinates 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); void PopupMessageCursor(IEntity viewer, string message);
} }