RobustToolbox/Robust.Shared/GameObjects/ComponentRegistration.cs

using System;
using System.Collections.Frozen;
using System.Collections.Generic;
using Robust.Shared.Collections;
using Robust.Shared.GameStates;

namespace Robust.Shared.GameObjects;

/// <summary>
/// Represents a component registered into a <see cref="IComponentFactory" />.
/// </summary>
/// <seealso cref="IComponentFactory" />
/// <seealso cref="IComponent" />
public sealed class ComponentRegistration
{
    /// <summary>
    /// The name of the component.
    /// This is used as the <c>type</c> field in the component declarations if entity prototypes.
    /// </summary>
    /// <seealso cref="IComponent.Name" />
    public string Name { get; }

    public CompIdx Idx { get; }

    /// <summary>
    /// If this is true, the component will not be saved when saving a map/grid.
    /// </summary>
    /// <seealso cref="UnsavedComponentAttribute"/>
    public bool Unsaved { get; }

    /// <summary>
    /// ID used to reference the component type across the network.
    /// If null, no network synchronization will be available for this component.
    /// </summary>
    /// <seealso cref="NetworkedComponentAttribute" />
    public ushort? NetID { get; internal set; }

    /// <summary>
    /// Whether this component type has <see cref="NetworkedComponentAttribute"/>.
    /// </summary>
    public bool Networked { get; internal set; }

    /// <summary>
    /// The type that will be instantiated if this component is created.
    /// </summary>
    public Type Type { get; }

    /// <summary>
    /// Fields that are networked for this component. Used for delta states.
    /// </summary>
    public string[] NetworkedFields = [];

    public FrozenDictionary<string, int> NetworkedFieldLookup = FrozenDictionary<string, int>.Empty;

    // Internal for sandboxing.
    // Avoid content passing an instance of this to ComponentFactory to get any type they want instantiated.
    internal ComponentRegistration(string name, Type type, CompIdx idx, bool unsaved = false)
    {
        Name = name;
        Type = type;
        Idx = idx;
        Unsaved = unsaved;
    }

    public override string ToString()
    {
        return $"ComponentRegistration({Name}: {Type})";
    }
}