67 lines
2.0 KiB
C#
67 lines
2.0 KiB
C#
using System.Numerics;
|
|
using Microsoft.Xna.Framework;
|
|
|
|
namespace Barotrauma.LuaCs.Configuration;
|
|
|
|
/// <summary>
|
|
/// Contains the Display Data for use with Menus.
|
|
/// </summary>
|
|
public interface IDisplayableData
|
|
{
|
|
/// <summary>
|
|
/// Internal name of the instance.
|
|
/// </summary>
|
|
string Name { get; }
|
|
/// <summary>
|
|
/// Internal mod name of the instance. ContentPackage name will be used by default.
|
|
/// </summary>
|
|
string ModName { get; }
|
|
/// <summary>
|
|
/// The name to display in GUIs and Menus.
|
|
/// </summary>
|
|
string DisplayName { get; }
|
|
/// <summary>
|
|
/// The mod name to display in GUIs and Menus.
|
|
/// </summary>
|
|
string DisplayModName { get; }
|
|
/// <summary>
|
|
/// Category this instance falls under. Used by menus when filtering by category.
|
|
/// </summary>
|
|
string DisplayCategory { get; }
|
|
/// <summary>
|
|
/// The tooltip shown on hover.
|
|
/// </summary>
|
|
string Tooltip { get; }
|
|
/// <summary>
|
|
/// The fully qualified filepath to the image icon for this config.
|
|
/// </summary>
|
|
string ImageIcon { get; }
|
|
/// <summary>
|
|
/// Required if ImageIcon is set. X,Y resolution of the image.
|
|
/// </summary>
|
|
Point IconResolution { get; }
|
|
/// <summary>
|
|
/// Whether to show the entry in the menu when not loaded.
|
|
/// </summary>
|
|
bool ShowWhenNotLoaded { get; }
|
|
}
|
|
|
|
public interface IDisplayableInitialize
|
|
{
|
|
void Initialize(IDisplayableData values);
|
|
|
|
// copy this as needed
|
|
/*public void Initialize(IDisplayableData values)
|
|
{
|
|
this.Name = values.Name;
|
|
this.ModName = values.ModName;
|
|
this.DisplayName = values.DisplayName;
|
|
this.DisplayModName = values.DisplayModName;
|
|
this.DisplayCategory = values.DisplayCategory;
|
|
this.Tooltip = values.Tooltip;
|
|
this.ImageIcon = values.ImageIcon;
|
|
this.IconResolution = values.IconResolution;
|
|
this.ShowWhenNotLoaded = values.ShowWhenNotLoaded;
|
|
}*/
|
|
}
|