tbd-station-14/Content.Server/UserInterface/ActivatableUIComponent.cs

using Content.Shared.Whitelist;
using Robust.Server.GameObjects;
using Robust.Server.Player;
using Robust.Shared.Player;
using Robust.Shared.Serialization.TypeSerializers.Implementations;

namespace Content.Server.UserInterface
{
    [RegisterComponent]
    public sealed partial class ActivatableUIComponent : Component
    {
        [DataField(required: true, customTypeSerializer:typeof(EnumSerializer))]
        public Enum? Key { get; set; }

        [ViewVariables(VVAccess.ReadWrite)]
        [DataField]
        public bool InHandsOnly { get; set; } = false;

        [DataField]
        public bool SingleUser { get; set; } = false;

        [ViewVariables(VVAccess.ReadWrite)]
        [DataField]
        public bool AdminOnly { get; set; } = false;

        [DataField]
        public LocId VerbText = "ui-verb-toggle-open";

        /// <summary>
        ///     Whether you need a hand to operate this UI. The hand does not need to be free, you just need to have one.
        /// </summary>
        /// <remarks>
        ///     This should probably be true for most machines & computers, but there will still be UIs that represent a
        ///     more generic interaction / configuration that might not require hands.
        /// </remarks>
        [ViewVariables(VVAccess.ReadWrite)]
        [DataField]
        public bool RequireHands = true;

        /// <summary>
        ///     Entities that are required to open this UI.
        /// </summary>
        [DataField("allowedItems")]
        [ViewVariables(VVAccess.ReadWrite)]
        public EntityWhitelist? AllowedItems = null;

        /// <summary>
        ///     Whether you can activate this ui with activateinhand or not
        /// </summary>
        [ViewVariables(VVAccess.ReadWrite)]
        [DataField]
        public bool RightClickOnly;

        /// <summary>
        ///     Whether spectators (non-admin ghosts) should be allowed to view this UI.
        /// </summary>
        [ViewVariables(VVAccess.ReadWrite)]
        [DataField]
        public bool AllowSpectator = true;

        /// <summary>
        ///     Whether the UI should close when the item is deselected due to a hand swap or drop
        /// </summary>
        [ViewVariables(VVAccess.ReadWrite)]
        [DataField]
        public bool CloseOnHandDeselect = true;

        /// <summary>
        ///     The client channel currently using the object, or null if there's none/not single user.
        ///     NOTE: DO NOT DIRECTLY SET, USE ActivatableUISystem.SetCurrentSingleUser
        /// </summary>
        [ViewVariables]
        public ICommonSession? CurrentSingleUser;
    }
}