Coin

Concrete Currency record representing the standard Townskeep monetary unit with gold, silver, and copper denominations. Provides implicit conversions, tuple decomposition, and indexer access.

Definition

Namespace: Paragon.Townskeep Assembly: Townskeep.dll

[Serializable]
public record Coin : Currency

Inheritance: Currency → Coin

Remarks

Coin decomposes a single int value into three denominations:

Denomination	Value	Decomposition
Gold	10,000	Value / 10000
Silver	100	(Value / 100) % 100
Copper	1	Value % 100

Implicit conversions allow ergonomic construction from int, (int, int, int) tuples, and back. Negative denomination values in the (gold, silver, copper) constructor are clamped to 0 via Mathf.Max.

Quick Lookup

Goal	How
Create from denominations	new Coin(2, 50, 75)
Create from raw value	new Coin(25075)
Implicit from int	Coin c = 25075;
Implicit from tuple	Coin c = (2, 50, 75);
Decompose to tuple	(int g, int s, int c) = coin;
Get denomination by index	coin[0] (gold), coin[1] (silver), coin[2] (copper)
Display formatted	coin.ToString() → "2g - 50s - 75c"
Compute raw from parts	Coin.GetValue(2, 50, 75) → 25075

Properties

Gold

Gold denomination (each gold = 10,000 base value).

[ShowInInspector]
public int Gold { get; }

Silver

Silver denomination (each silver = 100 base value, max 99 per gold).

[ShowInInspector]
public int Silver { get; }

Copper

Copper denomination (each copper = 1 base value, max 99 per silver).

[ShowInInspector]
public int Copper { get; }

Methods

Constructors

public Coin()                                    // 0 value
public Coin(int value)                           // from raw int
public Coin(int gold, int silver, int copper)    // from denominations

GetValue (static)

Converts gold/silver/copper to a raw integer. Clamps negative denominations to 0.

public static int GetValue(int gold, int silver, int copper)

Parameter	Type	Description
gold	int	Gold count (clamped to >= 0)
silver	int	Silver count (clamped to >= 0)
copper	int	Copper count (clamped to >= 0)

Returns: gold * 10000 + silver * 100 + copper

ToString

Returns the formatted denomination string.

public override string ToString()

Returns: "Xg - Ys - Zc" (e.g., "2g - 50s - 75c")

Operators

implicit operator Coin(int)

Creates a Coin from a raw integer value.

public static implicit operator Coin(int value)

implicit operator Coin((int, int, int))

Creates a Coin from a (gold, silver, copper) tuple.

public static implicit operator Coin((int gold, int silver, int copper) value)

implicit operator (int, int, int)(Coin)

Decomposes a Coin into a (gold, silver, copper) tuple.

public static implicit operator (int gold, int silver, int copper)(Coin coin)

Indexers

this[int]

Accesses a denomination by index: 0 = Gold, 1 = Silver, 2 = Copper.

public int this[int index] { get; }

Index	Denomination
0	Gold
1	Silver
2	Copper

Throws: IndexOutOfRangeException for index outside 0-2.

Common Pitfalls

Silver/copper overflow is allowed new Coin(0, 150, 0) produces value 15000, which decomposes as 1g 50s 0c. The constructor does not enforce max 99 per denomination — it simply sums the raw value. This is by design.

Inherited mutability from Currency Coin inherits SetValue(), AddValue(), and RemoveValue() from Currency, which mutate the internal value without clamping. After mutation, denomination properties reflect the new value.

Default Coin() is zero new Coin() creates a coin with value 0 (0g 0s 0c). This is valid but may be unexpected if a non-zero default was intended.

Examples

Price Comparison

Coin price = (1, 50, 0);      // 1g 50s 0c = 15000
Coin wallet = (2, 0, 0);      // 2g 0s 0c = 20000

if (wallet.Value >= price.Value)
{
    wallet.RemoveValue(price);  // implicit int conversion
    Debug.Log($"Purchased! Remaining: {wallet}");  // 0g - 50s - 0c
}

Iterating Denominations

Coin coin = new Coin(3, 25, 80);
string[] labels = { "Gold", "Silver", "Copper" };
for (int i = 0; i < 3; i++)
{
    Debug.Log($"{labels[i]}: {coin[i]}");
}

See Also

• Currency — abstract base record

• CoinDrawer — Inspector drawer for Coin fields