using Robust.Shared.Prototypes;
using Robust.Shared.Serialization;
using Robust.Shared.Utility;
namespace Content.Shared.Alert
{
///
/// An alert popup with associated icon, tooltip, and other data.
///
[Prototype("alert")]
public sealed class AlertPrototype : IPrototype, ISerializationHooks
{
[ViewVariables]
string IPrototype.ID => AlertType.ToString();
///
/// Type of alert, no 2 alert prototypes should have the same one.
///
[IdDataField]
public AlertType AlertType { get; private set; }
///
/// List of icons to use for this alert. Each entry corresponds to a different severity level, starting from the
/// minimum and incrementing upwards. If severities are not supported, the first entry is used.
///
[DataField("icons", required: true)]
public readonly List Icons = new();
///
/// Name to show in tooltip window. Accepts formatting.
///
[DataField("name")]
public string Name { get; private set; } = "";
///
/// Description to show in tooltip window. Accepts formatting.
///
[DataField("description")]
public string Description { get; private set; } = "";
///
/// Category the alert belongs to. Only one alert of a given category
/// can be shown at a time. If one is shown while another is already being shown,
/// it will be replaced. This can be useful for categories of alerts which should naturally
/// replace each other and are mutually exclusive, for example lowpressure / highpressure,
/// hot / cold. If left unspecified, the alert will not replace or be replaced by any other alerts.
///
[DataField("category")]
public AlertCategory? Category { get; private set; }
///
/// Key which is unique w.r.t category semantics (alerts with same category have equal keys,
/// alerts with no category have different keys).
///
public AlertKey AlertKey { get; private set; }
///
/// -1 (no effect) unless MaxSeverity is specified. Defaults to 1. Minimum severity level supported by this state.
///
public short MinSeverity => MaxSeverity == -1 ? (short) -1 : _minSeverity;
[DataField("minSeverity")] private short _minSeverity = 1;
///
/// Maximum severity level supported by this state. -1 (default) indicates
/// no severity levels are supported by the state.
///
[DataField("maxSeverity")]
public short MaxSeverity = -1;
///
/// Indicates whether this state support severity levels
///
public bool SupportsSeverity => MaxSeverity != -1;
///
/// Defines what to do when the alert is clicked.
/// This will always be null on clientside.
///
[DataField("onClick", serverOnly: true)]
public IAlertClick? OnClick { get; private set; }
void ISerializationHooks.AfterDeserialization()
{
if (AlertType == AlertType.Error)
{
Logger.ErrorS("alert", "missing or invalid alertType for alert with name {0}", Name);
}
AlertKey = new AlertKey(AlertType, Category);
}
/// severity level, if supported by this alert
/// the icon path to the texture for the provided severity level
public SpriteSpecifier GetIcon(short? severity = null)
{
if (!SupportsSeverity && severity != null)
{
throw new InvalidOperationException($"This alert ({AlertKey}) does not support severity");
}
var minIcons = SupportsSeverity
? MaxSeverity - MinSeverity : 1;
if (Icons.Count < minIcons)
throw new InvalidOperationException($"Insufficient number of icons given for alert {AlertType}");
if (!SupportsSeverity)
return Icons[0];
if (severity == null)
{
throw new ArgumentException($"No severity specified but this alert ({AlertKey}) has severity.", nameof(severity));
}
if (severity < MinSeverity)
{
throw new ArgumentOutOfRangeException(nameof(severity), $"Severity below minimum severity in {AlertKey}.");
}
if (severity > MaxSeverity)
{
throw new ArgumentOutOfRangeException(nameof(severity), $"Severity above maximum severity in {AlertKey}.");
}
return Icons[severity.Value - _minSeverity];
}
}
}