Class ClothingMetadataCatalog

Namespace

S1API.Items.Clothing

Assembly

S1API.dll

Provides read-only access to the base game's clothing slot and color metadata.

public static class ClothingMetadataCatalog

Inheritance

object

ClothingMetadataCatalog

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Colors

Gets a read-only snapshot of all available clothing color metadata. Returns an empty list before the base game's clothing utility is ready.

public static IReadOnlyList<ClothingColorMetadata> Colors { get; }

Property Value

IReadOnlyList<ClothingColorMetadata>

Slots

Gets a read-only snapshot of all available clothing slot metadata. Returns an empty list before the base game's clothing utility is ready.

public static IReadOnlyList<ClothingSlotMetadata> Slots { get; }

Property Value

IReadOnlyList<ClothingSlotMetadata>

Methods

GetColor(ClothingColor)

Gets metadata for a clothing color.

public static ClothingColorMetadata? GetColor(ClothingColor color)

Parameters

color ClothingColor

The clothing color to look up.

Returns

ClothingColorMetadata

The color metadata, or null when the color is unavailable or the base game's clothing utility is not ready.

GetSlot(ClothingSlot)

Gets metadata for a clothing slot.

public static ClothingSlotMetadata? GetSlot(ClothingSlot slot)

Parameters

slot ClothingSlot

The clothing slot to look up.

Returns

ClothingSlotMetadata

The slot metadata, or null when the slot is unavailable or the base game's clothing utility is not ready.

TryGetColor(ClothingColor, out ClothingColorMetadata?)

Tries to get metadata for a clothing color.

public static bool TryGetColor(ClothingColor color, out ClothingColorMetadata? metadata)

Parameters

color ClothingColor

The clothing color to look up.

metadata ClothingColorMetadata

The resolved metadata when available.

Returns

bool

true when metadata was found.

TryGetSlot(ClothingSlot, out ClothingSlotMetadata?)

Tries to get metadata for a clothing slot.

public static bool TryGetSlot(ClothingSlot slot, out ClothingSlotMetadata? metadata)

Parameters

slot ClothingSlot

The clothing slot to look up.

metadata ClothingSlotMetadata

The resolved metadata when available.

Returns

bool

true when metadata was found.