UserInterfaceComponent.cs

using System;
using System.Collections.Generic;
using Robust.Shared.GameStates;
using Robust.Shared.Player;
using Robust.Shared.Serialization;
using Robust.Shared.Serialization.Manager;
using Robust.Shared.Serialization.Manager.Attributes;
using Robust.Shared.Timing;
using Robust.Shared.ViewVariables;

namespace Robust.Shared.GameObjects
{
    [RegisterComponent, NetworkedComponent, Access(typeof(SharedUserInterfaceSystem))]
    public sealed partial class UserInterfaceComponent : Component, IComponentDelta
    {
        /// <inheritdoc/>
        public GameTick LastUnclassifiedDirty { get; set; }

        /// <inheritdoc />
        public GameTick[] LastModifiedFields { get; set; } = default!;

        /// <summary>
        /// The currently open interfaces. Used clientside to store the UI.
        /// </summary>
        [ViewVariables, Access(Friend = AccessPermissions.ReadWriteExecute, Other = AccessPermissions.ReadWriteExecute)]
        public readonly Dictionary<Enum, BoundUserInterface> ClientOpenInterfaces = new();

        [DataField, AlwaysPushInheritance]
        internal Dictionary<Enum, InterfaceData> Interfaces = new();

        /// <summary>
        /// Actors that currently have interfaces open.
        /// </summary>
        [DataField]
        public Dictionary<Enum, HashSet<EntityUid>> Actors = new();

        /// <summary>
        /// Legacy data, new BUIs should be using comp states.
        /// </summary>
        public Dictionary<Enum, BoundUserInterfaceState> States = new();
    }

    [Serializable, NetSerializable]
    internal sealed class UserInterfaceComponentState(
        Dictionary<Enum, List<NetEntity>> actors,
        Dictionary<Enum, BoundUserInterfaceState> states,
        Dictionary<Enum, InterfaceData> data)
        : IComponentState
    {
        public Dictionary<Enum, List<NetEntity>> Actors = actors;

        public Dictionary<Enum, BoundUserInterfaceState> States = states;

        public Dictionary<Enum, InterfaceData> Data = data;
    }

    [Serializable, NetSerializable]
    internal sealed class UserInterfaceActorsDeltaState : IComponentDeltaState<UserInterfaceComponentState>
    {
        public Dictionary<Enum, List<NetEntity>> Actors = new();

        public void ApplyToFullState(UserInterfaceComponentState fullState)
        {
            fullState.Actors.Clear();

            foreach (var (key, value) in Actors)
            {
                fullState.Actors.Add(key, value);
            }
        }

        public UserInterfaceComponentState CreateNewFullState(UserInterfaceComponentState fullState)
        {
            var newState = new UserInterfaceComponentState(
                new Dictionary<Enum, List<NetEntity>>(Actors),
                new(fullState.States),
                new(fullState.Data));

            return newState;
        }
    }

    [Serializable, NetSerializable]
    internal sealed class UserInterfaceStatesDeltaState : IComponentDeltaState<UserInterfaceComponentState>
    {
        public Dictionary<Enum, BoundUserInterfaceState> States = new();

        public void ApplyToFullState(UserInterfaceComponentState fullState)
        {
            fullState.States.Clear();

            foreach (var (key, value) in States)
            {
                fullState.States.Add(key, value);
            }
        }

        public UserInterfaceComponentState CreateNewFullState(UserInterfaceComponentState fullState)
        {
            var newState = new UserInterfaceComponentState(
                new Dictionary<Enum, List<NetEntity>>(fullState.Actors),
                new(States),
                new(fullState.Data));

            return newState;
        }
    }

    [DataDefinition, Serializable, NetSerializable]
    public sealed partial class InterfaceData
    {
        [DataField("type", required: true)]
        public string ClientType { get; private set; } = default!;

        /// <summary>
        ///     Maximum range before a BUI auto-closes. A non-positive number means there is no limit.
        /// </summary>
        [DataField]
        public float InteractionRange = 2f;

        // TODO BUI move to content?
        // I've tried to keep the name general, but really this is a bool for: can ghosts/stunned/dead people press buttons on this UI?
        /// <summary>
        ///     Determines whether the server should verify that a client is capable of performing generic UI interactions when receiving UI messages.
        /// </summary>
        /// <remarks>
        ///     Avoids requiring each system to individually validate client inputs. However, perhaps some BUIs are supposed to be bypass accessibility checks
        /// </remarks>
        [DataField]
        public bool RequireInputValidation = true;

        public InterfaceData(string clientType, float interactionRange = 2f, bool requireInputValidation = true)
        {
            ClientType = clientType;
            InteractionRange = interactionRange;
            RequireInputValidation = requireInputValidation;
        }
        public InterfaceData(InterfaceData data)
        {
            ClientType = data.ClientType;
            InteractionRange = data.InteractionRange;
            RequireInputValidation = data.RequireInputValidation;
        }
    }

    /// <summary>
    /// Raised whenever the server receives a BUI message from a client relating to a UI that requires input validation.
    /// This is first broadcast then, if not cancelled already, raised directly on the BUI's owner.
    /// </summary>
    [ByRefEvent]
    public record struct BoundUserInterfaceMessageAttempt(EntityUid Actor, EntityUid Target, Enum UiKey, BoundUserInterfaceMessage Message)
    {
        public bool Cancelled { get; private set; }

        public void Cancel()
        {
            Cancelled = true;
        }

        public void Uncancel()
        {
            Cancelled = false;
        }
    }

    /// <summary>
    ///     Raised whenever the server receives a BUI wrap message from a client for a valid interface.
    /// </summary>
    [ByRefEvent]
    public readonly record struct BoundUserInterfaceMessageReceivedEvent(
        EntityUid Actor,
        EntityUid Target,
        Enum UiKey);

    [NetSerializable, Serializable]
    public abstract class BoundUserInterfaceState
    {
    }

    /// <summary>
    /// Abstract class for local BUI events.
    /// </summary>
    public abstract class BaseLocalBoundUserInterfaceEvent : BaseBoundUserInterfaceEvent
    {
        /// <summary>
        ///     The Entity receiving the message.
        ///     Only set when the message is raised as a directed event.
        /// </summary>
        public EntityUid Entity = EntityUid.Invalid;
    }

    /// <summary>
    /// Abstract class for all BUI events.
    /// </summary>
    [Serializable, NetSerializable]
    public abstract class BaseBoundUserInterfaceEvent : EntityEventArgs
    {
        /// <summary>
        ///     The UI of this message.
        ///     Only set when the message is raised as a directed event.
        /// </summary>
        public Enum UiKey = default!;

        /// <summary>
        ///     The session sending or receiving this message.
        ///     Only set when the message is raised as a directed event.
        /// </summary>
        [NonSerialized]
        public EntityUid Actor = default!;
    }

    /// <summary>
    /// Abstract class for networked BUI events.
    /// </summary>
    [NetSerializable, Serializable]
    public abstract class BoundUserInterfaceMessage : BaseBoundUserInterfaceEvent
    {
        /// <summary>
        ///     The Entity receiving the message.
        ///     Only set when the message is raised as a directed event.
        /// </summary>
        public NetEntity Entity { get; set; } = NetEntity.Invalid;
    }

    [NetSerializable, Serializable]
    public sealed class OpenBoundInterfaceMessage : BoundUserInterfaceMessage
    {
    }

    [NetSerializable, Serializable]
    public sealed class CloseBoundInterfaceMessage : BoundUserInterfaceMessage
    {
    }

    [Serializable, NetSerializable]
    internal abstract class BaseBoundUIWrapMessage(NetEntity entity, BoundUserInterfaceMessage message, Enum uiKey)
        : EntityEventArgs
    {
        public readonly NetEntity Entity = entity;
        public readonly BoundUserInterfaceMessage Message = message;
        public readonly Enum UiKey = uiKey;
    }

    /// <summary>
    /// Helper message raised from client to server.
    /// </summary>
    [Serializable, NetSerializable]
    internal sealed class BoundUIWrapMessage(NetEntity entity, BoundUserInterfaceMessage message, Enum uiKey)
        : BaseBoundUIWrapMessage(entity, message, uiKey);

    public sealed class BoundUIOpenedEvent : BaseLocalBoundUserInterfaceEvent
    {
        public BoundUIOpenedEvent(Enum uiKey, EntityUid uid, EntityUid actor)
        {
            UiKey = uiKey;
            Entity = uid;
            Actor = actor;
        }
    }

    public sealed class BoundUIClosedEvent : BaseLocalBoundUserInterfaceEvent
    {
        public BoundUIClosedEvent(Enum uiKey, EntityUid uid, EntityUid actor)
        {
            UiKey = uiKey;
            Entity = uid;
            Actor = actor;
        }
    }
}