RobustToolbox/SS14.Shared/Interfaces/Map/ITileDefinition.cs

namespace SS14.Shared.Interfaces.Map
{
    /// <summary>
    ///     The definition (template) for a grid tile.
    /// </summary>
    public interface ITileDefinition
    {
        /// <summary>
        ///     The numeric tile ID used to refer to this tile inside the map datastructure.
        /// </summary>
        ushort TileId { get; }

        /// <summary>
        ///     The name of the definition. This is user facing.
        /// </summary>
        string DisplayName { get; }

        /// <summary>
        ///     Internal name of the definition.
        /// </summary>
        string Name { get; }

        /// <summary>
        ///     The name of the sprite to draw.
        /// </summary>
        string SpriteName { get; }

        /// <summary>
        ///     Assign a new value to <see cref="TileId"/>, used when registering the tile definition.
        /// </summary>
        /// <param name="id">The new tile ID for this tile definition.</param>
        void AssignTileId(ushort id);
    }
}