using Robust.Shared.Serialization;

namespace Content.Shared.TextScreen;

/// <summary>
/// AppearanceData keys for text screen data.
/// </summary>
[Serializable, NetSerializable]
public enum TextScreenVisuals : byte
{
    // TODO: support for a small image, I think. Probably want to rename textscreen to just screen then.
    /// <summary>
    /// What text to default to after timer completion?
    /// Expects a <see cref="string"/>.
    /// </summary>
    DefaultText,

    /// <summary>
    /// What text to render?<br/>
    /// Expects a <see cref="string"/>.
    /// </summary>
    ScreenText,

    /// <summary>
    /// The reference time for the text. Useful for scroll synchronization.<br/>
    /// Expects a <see cref="TimeSpan"/>.
    /// </summary>
    ScreenTextTime,

    /// <summary>
    /// If this is a timer, this is the time we're counting down to.<br/>
    /// Expects a <see cref="TimeSpan"/>.
    /// </summary>
    TargetTime,

    /// <summary>
    /// Change text color on the entire screen.
    /// Expects a <see cref="Color"/>.
    /// </summary>
    Color
}

/// <summary>
/// Layers for text screen sprites.
/// </summary>
[Serializable, NetSerializable]
public enum TextScreenVisualLayers : byte
{
    /// <summary>
    /// A frame to draw over the text on screen to obscure the scrolling effect.
    /// Will be reordered to be on top of the text layers.
    /// </summary>
    Frame
}