49 lines
1.5 KiB
C#
49 lines
1.5 KiB
C#
using Robust.Shared.Prototypes;
|
|
using Robust.Shared.Serialization.TypeSerializers.Implementations.Custom.Prototype.List;
|
|
using Robust.Shared.Utility;
|
|
|
|
namespace Content.Client.Guidebook;
|
|
|
|
[Virtual]
|
|
public class GuideEntry
|
|
{
|
|
/// <summary>
|
|
/// The file containing the contents of this guide.
|
|
/// </summary>
|
|
[DataField("text", required: true)] public ResPath Text = default!;
|
|
|
|
/// <summary>
|
|
/// The unique id for this guide.
|
|
/// </summary>
|
|
[IdDataField]
|
|
public string Id = default!;
|
|
|
|
/// <summary>
|
|
/// The name of this guide. This gets localized.
|
|
/// </summary>
|
|
[DataField("name", required: true)] public string Name = default!;
|
|
|
|
/// <summary>
|
|
/// The "children" of this guide for when guides are shown in a tree / table of contents.
|
|
/// </summary>
|
|
[DataField("children", customTypeSerializer:typeof(PrototypeIdListSerializer<GuideEntryPrototype>))]
|
|
public List<string> Children = new();
|
|
|
|
/// <summary>
|
|
/// Enable filtering of items.
|
|
/// </summary>
|
|
[DataField("filterEnabled")] public bool FilterEnabled = default!;
|
|
|
|
/// <summary>
|
|
/// Priority for sorting top-level guides when shown in a tree / table of contents.
|
|
/// If the guide is the child of some other guide, the order simply determined by the order of children in <see cref="Children"/>.
|
|
/// </summary>
|
|
[DataField("priority")] public int Priority = 0;
|
|
}
|
|
|
|
[Prototype("guideEntry")]
|
|
public sealed partial class GuideEntryPrototype : GuideEntry, IPrototype
|
|
{
|
|
public string ID => Id;
|
|
}
|