Component:QuantityTextFormatDriver

From Resonite Wiki
Revision as of 19:42, 7 February 2025 by Alizard (talk | contribs)
Component image 
Quantity Text Format Driver`1 component as seen in the Scene Inspector


This article or section is a Stub. You can help the Resonite Wiki by expanding it. The QuantityTextFormatDriver allows driving a string with an auto formatted quantity.

Usage

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.
Target field drive of String
BaseValue Double
FormatUnit String
FormatNumber String
CompoundFormatUnits direct SyncFieldList`1<String>
CompoundUseLongNames Bool
CompoundOverrideNames Bool
CompoundDiscardLastFraction Bool
CompoundSeparator String
CompoundZeroHandling CompoundZeroHandling

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.

Examples

See Also