CatStation/Content.Server/Power/Components/PowerMonitoringDeviceComponent.cs

using Content.Server.NodeContainer;
using Content.Server.NodeContainer.NodeGroups;
using Content.Server.Power.EntitySystems;
using Content.Shared.NodeContainer;
using Content.Shared.Power;

namespace Content.Server.Power.Components;

/// <summary>
///     Used to flag any entities that should appear on a power monitoring console
/// </summary>
[RegisterComponent, Access(typeof(PowerMonitoringConsoleSystem))]
public sealed partial class PowerMonitoringDeviceComponent : Component
{
    /// <summary>
    ///     Name of the node that this device draws its power from (see <see cref="NodeContainerComponent"/>)
    /// </summary>
    [DataField("sourceNode"), ViewVariables]
    public string SourceNode = string.Empty;

    /// <summary>
    ///     Name of the node that this device distributes power to (see <see cref="NodeContainerComponent"/>)
    /// </summary>
    [DataField("loadNode"), ViewVariables]
    public string LoadNode = string.Empty;

    /// <summary>
    ///     Names of the nodes that this device can potentially distributes power to (see <see cref="NodeContainerComponent"/>)
    /// </summary>
    [DataField("loadNodes"), ViewVariables]
    public List<string>? LoadNodes;

    /// <summary>
    ///     This entity will be grouped with entities that have the same collection name
    /// </summary>
    [DataField("collectionName"), ViewVariables]
    public string CollectionName = string.Empty;

    [ViewVariables]
    public BaseNodeGroup? NodeGroup = null;

    /// <summary>
    ///     Indicates whether the entity is/should be part of a collection
    /// </summary>
    public bool IsCollectionMasterOrChild { get { return CollectionName != string.Empty; } }

    /// <summary>
    ///     Specifies the uid of the master that represents this entity
    /// </summary>
    /// <remarks>
    ///     Used when grouping multiple entities into a single power monitoring console entry
    /// </remarks>
    [ViewVariables]
    public EntityUid CollectionMaster;

    /// <summary>
    ///     Indicates if this entity represents a group of entities
    /// </summary>
    /// <remarks>
    ///     Used when grouping multiple entities into a single power monitoring console entry
    /// </remarks>
    public bool IsCollectionMaster { get { return Owner == CollectionMaster; } }

    /// <summary>
    ///     A list of other entities that are to be represented by this entity
    /// </summary>
    /// /// <remarks>
    ///     Used when grouping multiple entities into a single power monitoring console entry
    /// </remarks>
    [ViewVariables]
    public Dictionary<EntityUid, PowerMonitoringDeviceComponent> ChildDevices = new();

    /// <summary>
    /// Path to the .rsi folder
    /// </summary>
    [DataField("sprite"), ViewVariables]
    public string SpritePath = string.Empty;

    /// <summary>
    /// The .rsi state
    /// </summary>
    [DataField("state"), ViewVariables]
    public string SpriteState = string.Empty;

    /// <summary>
    ///    Determines what power monitoring group this entity should belong to 
    /// </summary>
    [DataField("group", required: true), ViewVariables]
    public PowerMonitoringConsoleGroup Group;
}