d776c4b392
Fixes #26211 Admin messages now have separate "seen" and "dismissed" fields. The idea is that an admin should be able to tell whether a user pressed the "dismiss for now" button. Instead of using "seen" as "show this message to players when they join", "dismissed" is now used for this. Existing notes in the database will automatically be marked as dismissed on migration. A note cannot be dismissed without being seen (enforced via constraint in the database too, aren't I fancy). As part of this, it has become impossible for a player to play without dismissing the message in some form. Instead of a shitty popup window, the popup is now a fullscreen overlay that blocks clicks behind it, making the game unplayable. Also, if a user somehow has multiple messages they will be combined into one popup. Also I had enough respect for the codebase to make it look better and clean up the code somewhat. Yippee.
58 lines
2.6 KiB
C#
58 lines
2.6 KiB
C#
using System.Threading.Tasks;
|
|
using Content.Server.Database;
|
|
using Content.Shared.Administration.Notes;
|
|
using Content.Shared.Database;
|
|
using Robust.Shared.Player;
|
|
|
|
namespace Content.Server.Administration.Notes;
|
|
|
|
public interface IAdminNotesManager
|
|
{
|
|
event Action<SharedAdminNote>? NoteAdded;
|
|
event Action<SharedAdminNote>? NoteModified;
|
|
event Action<SharedAdminNote>? NoteDeleted;
|
|
|
|
bool CanCreate(ICommonSession admin);
|
|
bool CanDelete(ICommonSession admin);
|
|
bool CanEdit(ICommonSession admin);
|
|
bool CanView(ICommonSession admin);
|
|
Task OpenEui(ICommonSession admin, Guid notedPlayer);
|
|
Task OpenUserNotesEui(ICommonSession player);
|
|
Task AddAdminRemark(ICommonSession createdBy, Guid player, NoteType type, string message, NoteSeverity? severity, bool secret, DateTime? expiryTime);
|
|
Task DeleteAdminRemark(int noteId, NoteType type, ICommonSession deletedBy);
|
|
Task ModifyAdminRemark(int noteId, NoteType type, ICommonSession editedBy, string message, NoteSeverity? severity, bool secret, DateTime? expiryTime);
|
|
/// <summary>
|
|
/// Queries the database and retrieves all notes, secret and visible
|
|
/// </summary>
|
|
/// <param name="player">Desired player's <see cref="Guid"/></param>
|
|
/// <returns>ALL non-deleted notes, secret or not</returns>
|
|
Task<List<IAdminRemarksRecord>> GetAllAdminRemarks(Guid player);
|
|
/// <summary>
|
|
/// Queries the database and retrieves the notes a player should see
|
|
/// </summary>
|
|
/// <param name="player">Desired player's <see cref="Guid"/></param>
|
|
/// <returns>All player-visible notes</returns>
|
|
Task<List<IAdminRemarksRecord>> GetVisibleRemarks(Guid player);
|
|
/// <summary>
|
|
/// Queries the database and retrieves watchlists that may have been placed on the player
|
|
/// </summary>
|
|
/// <param name="player">Desired player's <see cref="Guid"/></param>
|
|
/// <returns>Active watchlists</returns>
|
|
Task<List<AdminWatchlistRecord>> GetActiveWatchlists(Guid player);
|
|
/// <summary>
|
|
/// Queries the database and retrieves new messages a player has gotten
|
|
/// </summary>
|
|
/// <param name="player">Desired player's <see cref="Guid"/></param>
|
|
/// <returns>All unread messages</returns>
|
|
Task<List<AdminMessageRecord>> GetNewMessages(Guid player);
|
|
|
|
/// <summary>
|
|
/// Mark an admin message as being seen by the target player.
|
|
/// </summary>
|
|
/// <param name="id">The database ID of the admin message.</param>
|
|
/// <param name="dismissedToo">
|
|
/// If true, the message is "permanently dismissed" and will not be shown to the player again when they join.
|
|
/// </param>
|
|
Task MarkMessageAsSeen(int id, bool dismissedToo);
|
|
}
|