Class ProductKindMetadata

Namespace

S1API.Products

Assembly

S1API.dll

Describes the presentation and Product Manager behavior of a logical product kind.

public sealed class ProductKindMetadata

Inheritance

object

ProductKindMetadata

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Remarks

Metadata is immutable and is registered separately from product definitions, discovery, and listing state.

Properties

Color

Gets the color used for native metadata and Product Manager presentation.

public Color Color { get; }

Property Value

Color

DisplayName

Gets the user-facing product-kind name.

public string DisplayName { get; }

Property Value

string

Icon

Gets the optional icon used by a visible Product Manager section.

public Sprite? Icon { get; }

Property Value

Sprite

IsVisibleInProductManager

Gets whether custom products of this kind are shown in the Product Manager.

public bool IsVisibleInProductManager { get; }

Property Value

bool

ProductKind

Gets the logical product kind described by this metadata.

public ProductKind ProductKind { get; }

Property Value

ProductKind

SearchAliases

Gets the additional case-insensitive terms that identify this product kind, in registration order.

public IReadOnlyList<string> SearchAliases { get; }

Property Value

IReadOnlyList<string>

Remarks

Alias order is preserved as part of the immutable metadata snapshot and therefore participates in duplicate-registration equivalence.

SortOrder

Gets the relative order of this product kind among custom Product Manager sections.

public int SortOrder { get; }

Property Value

int

Methods

MatchesSearch(string)

Determines whether a search term matches this metadata's identifier, display name, or aliases.

public bool MatchesSearch(string searchTerm)

Parameters

searchTerm string

The term to match.

Returns

bool

true when any searchable value contains the term.

Exceptions

ArgumentNullException

Thrown when searchTerm is null.