Traveller/scripts/item/IItemStack.cs

49 lines
1.2 KiB
C#
Raw Normal View History

using System;
using Godot;
2024-06-10 15:08:48 +00:00
namespace ColdMint.scripts.item;
public interface IItemStack
{
/// <summary>
/// <para>ID of items inside current stack</para>
/// </summary>
string Id { get; }
/// <summary>
/// <para>Max number of current stack</para>
/// </summary>
int MaxQuantity { get; }
/// <summary>
/// <para>Quantity of current stack</para>
/// </summary>
int Quantity { get; }
2024-06-10 15:08:48 +00:00
/// <summary>
/// <para>Icon of current item</para>
/// </summary>
Texture2D Icon { get; }
2024-06-10 15:08:48 +00:00
/// <summary>
/// <para>Display name of current item</para>
/// </summary>
string Name { get; }
2024-06-10 15:08:48 +00:00
/// <summary>
/// <para>Description of current item, which may show in inventory</para>
/// </summary>
string? Description { get; }
/// <summary>
/// Create a new ItemStack with the given item as the first item
/// </summary>
public static IItemStack FromItem(IItem_New item) => ItemTypeManager.MaxStackQuantityOf(item.Id) switch
{
1 => new SingleItemStack(item),
> 1 => throw new NotImplementedException(),
var other => throw new ArgumentException($"item {item} of type '{item.Id}' has unexpected max stack quantity {other}")
};
2024-06-10 15:08:48 +00:00
}