Class ChooseFormatter

Provides the ability to add logic to a Smart String by selecting an output using a provided set of choices.

Inheritance
Object
FormatterBase
ChooseFormatter
Inherited Members
Namespace: UnityEngine.Localization.SmartFormat.Extensions
Syntax
[Serializable]
public class ChooseFormatter : FormatterBase, IFormatter, ISerializationCallbackReceiver, IFormatterLiteralExtractor

Constructors

ChooseFormatter()

Creates a new instance of the formatter.

Declaration
public ChooseFormatter()

Properties

DefaultNames

Default names to use when Names is null.

Declaration
public override string[] DefaultNames { get; }
Property Value
Type Description
String[]
Overrides

SplitChar

The character used to split the choices. By default this is the pipe chartacter |.

Declaration
public char SplitChar { get; set; }
Property Value
Type Description
Char

Methods

TryEvaluateFormat(IFormattingInfo)

Writes the current value to the output, using the specified format. IF this extension cannot write the value, returns false, otherwise true.

Declaration
public override bool TryEvaluateFormat(IFormattingInfo formattingInfo)
Parameters
Type Name Description
IFormattingInfo formattingInfo
Returns
Type Description
Boolean
Overrides

WriteAllLiterals(IFormattingInfo)

Ignores the format arguments and writes every possible literal value. This is used to extract all possible values so that we can determine the distinct characters for font generation etc.

Declaration
public void WriteAllLiterals(IFormattingInfo formattingInfo)
Parameters
Type Name Description
IFormattingInfo formattingInfo
Implements