Struct SpecialFormat

Namespace

Uncreated.Warfare.Translations.Util

Assembly

Uncreated.Warfare.dll

Describes a format preset with a display name. Meant to be defined as init-only constants.

public readonly struct SpecialFormat

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SpecialFormat(string, string, bool)

public SpecialFormat(string displayName, string format, bool useForToString = true)

Parameters

displayName string

format string

useForToString bool

Properties

DisplayName

The format type name as displayed in the comments of the translation file.

public string DisplayName { get; }

Property Value

string

Format

The actual case-sensitive string used to identify the format.

public string Format { get; }

Property Value

string

UseForToString

If this format should be given to the ToString(string, IFormatProvider) function, otherwise it's just available to addons.

public bool UseForToString { get; }

Property Value

bool

Methods

Match(string?)

Check if a format matches this format.

public bool Match(string? fmt)

Parameters

fmt string

Returns

bool

Match(in ValueFormatParameters)

Check if a format matches this format.

public bool Match(in ValueFormatParameters args)

Parameters

args ValueFormatParameters

Returns

bool