Component:ValueTextFormatDriver

Component image 

Value Text Format Driver`1 component as seen in the Scene Inspector

ValueTextFormatDriver applies the value of a single source field to a text format string and drives the target string field. The source field is element 0 in the format string. Elements are defined by putting {} brackets around a number. Although the image shown and the field list below have the source field being a float, this component is generic, so any field type (that can be converted to a string) can be used.

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
Source	direct RelayRef`1<IField`1<T>>	The source field for the value.
Format	String	The string format with "{0}" in it somewhere
Text	field drive of String	The target field.

Usage

Attach to a slot and provide a format string and source value in order to drive a string field (possibly text) with the formatted number.

Examples

Screenshot of a quick example using ValueTextFormatDriver

Can be used to drive the descriptions on UIX, context menus, or visuals without involving flux.

See Also

• StringConcatenationDriver for combining the output with multiple other bits of text for a more robust final product.
• MultiValueTextFormatDriver for more than one source.