StarHorizon_Public/Content.Shared/Holopad/HolopadComponent.cs

using Content.Shared.Telephone;
using Robust.Shared.GameStates;
using Robust.Shared.Prototypes;
using Robust.Shared.Serialization;

namespace Content.Shared.Holopad;

/// <summary>
/// Holds data pertaining to holopads
/// </summary>
/// <remarks>
/// Holopads also require a <see cref="TelephoneComponent"/> to function
/// </remarks>
[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
[Access(typeof(SharedHolopadSystem))]
public sealed partial class HolopadComponent : Component
{
    /// <summary>
    /// The entity being projected by the holopad
    /// </summary>
    [ViewVariables]
    public Entity<HolopadHologramComponent>? Hologram;

    /// <summary>
    /// The entity using the holopad
    /// </summary>
    [ViewVariables]
    public Entity<HolopadUserComponent>? User;

    /// <summary>
    /// Proto ID for the user's hologram
    /// </summary>
    [DataField]
    public EntProtoId? HologramProtoId;

    /// <summary>
    /// The entity that has locked out the controls of this device
    /// </summary>
    [ViewVariables, AutoNetworkedField]
    public EntityUid? ControlLockoutOwner = null;

    /// <summary>
    /// The game tick the control lockout was initiated
    /// </summary>
    [ViewVariables, AutoNetworkedField]
    public TimeSpan ControlLockoutStartTime;

    /// <summary>
    /// The duration that the control lockout will last in seconds
    /// </summary>
    [DataField]
    public float ControlLockoutDuration { get; private set; } = 90f;

    /// <summary>
    /// The duration before the controls can be lockout again in seconds
    /// </summary>
    [DataField]
    public float ControlLockoutCoolDown { get; private set; } = 180f;

    /// <summary>
    /// Frontier - If true, will sync pad name with a station name.
    /// </summary>
    [ViewVariables]
    [DataField]
    public bool UseStationName { get; set; }

    /// <summary>
    /// Frontier - If added with UseStationName will add a Prefix to the name
    /// </summary>
    [ViewVariables]
    [DataField]
    public string? StationNamePrefix { get; set; } = null;

    /// <summary>
    /// Frontier - If added with UseStationName will add a suffix to the name
    /// </summary>
    [ViewVariables]
    [DataField]
    public string? StationNameSuffix { get; set; } = null;
}

#region: Event messages

/// <summary>
///     Data from by the server to the client for the holopad UI
/// </summary>
[Serializable, NetSerializable]
public sealed class HolopadBoundInterfaceState : BoundUserInterfaceState
{
    public readonly Dictionary<NetEntity, string> Holopads;

    public HolopadBoundInterfaceState(Dictionary<NetEntity, string> holopads)
    {
        Holopads = holopads;
    }
}

/// <summary>
///     Triggers the server to send updated power monitoring console data to the client for the single player session
/// </summary>
[Serializable, NetSerializable]
public sealed class HolopadStartNewCallMessage : BoundUserInterfaceMessage
{
    public readonly NetEntity Receiver;

    public HolopadStartNewCallMessage(NetEntity receiver)
    {
        Receiver = receiver;
    }
}

/// <summary>
///     Triggers the server to send updated power monitoring console data to the client for the single player session
/// </summary>
[Serializable, NetSerializable]
public sealed class HolopadAnswerCallMessage : BoundUserInterfaceMessage { }

/// <summary>
///     Triggers the server to send updated power monitoring console data to the client for the single player session
/// </summary>
[Serializable, NetSerializable]
public sealed class HolopadEndCallMessage : BoundUserInterfaceMessage { }

/// <summary>
///     Triggers the server to send updated power monitoring console data to the client for the single player session
/// </summary>
[Serializable, NetSerializable]
public sealed class HolopadStartBroadcastMessage : BoundUserInterfaceMessage { }

/// <summary>
///     Triggers the server to send updated power monitoring console data to the client for the single player session
/// </summary>
[Serializable, NetSerializable]
public sealed class HolopadActivateProjectorMessage : BoundUserInterfaceMessage { }

/// <summary>
///     Triggers the server to send updated power monitoring console data to the client for the single player session
/// </summary>
[Serializable, NetSerializable]
public sealed class HolopadStationAiRequestMessage : BoundUserInterfaceMessage { }

#endregion

/// <summary>
/// Key to the Holopad UI
/// </summary>
[Serializable, NetSerializable]
public enum HolopadUiKey : byte
{
    InteractionWindow,
    InteractionWindowForAi,
    AiActionWindow,
    AiRequestWindow
}