Component:QuantityTextFormatDriver

CollapseComponent image 

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

The QuantityTextFormatDriver allows driving a string with an auto formatted quantity.

Fields

Fields Collapse

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.
Target	field drive of String	The field to drive with the formatted Quantity string.
BaseValue	Double	Value to get converted into string
FormatUnit	String	Unit to format BaseValue in.
FormatNumber	String	How to format the number when making it part of the string (So if it should remove decimals.
CompoundFormatUnits	direct SyncFieldList`1<String>	A list of format Units this can use to format the base value (common ones are "ft" as an entry followed by another entry with "in" or "m" as an entry followed by another entry with "cm" ).
CompoundUseLongNames	Bool	Show the long names of compound units.
CompoundOverrideNames	Bool	Whether the compound format unit names should be used rather than their usual name.
CompoundDiscardLastFraction	Bool	Whether to discard the decimal of the smallest unit being displayed in the output or not. (so "3m 2.5cm" will become 3m 2cm")
CompoundSeparator	String	String to put between compound units.
CompoundZeroHandling	CompoundZeroHandling	Remove or trim compound units with a value of zero.

Behavior

The most suitable unit type is automatically chosen based on the BaseValue, you can override this behavior by inputting a unit type into FormatUnit or using compound units.