ProtoFlux:Format Quantity

From Resonite Wiki
Revision as of 14:52, 8 September 2024 by JackTheFoxOtter (talk | contribs) (Updated description and linked to new quantity types page. "QuantityX" doesn't exist in Resonite.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Format Quantity <Type>
Value
*
FormatUnit
FormatNumber
UseLongNames
Quantity

The Format Quantity node takes in value as a quantity type, the unit in which the quantity should be displayed as a string, as well as wether to use the unit's long name instead of the short form. It returns a formatted string containing the quantity value in the specified unit.

To create this node, you need to specify a valid quantity type for its generic parameter. Examples: Mass, Time, and Voltage.

Inputs

Value (Quantity)

The quantity value.

FormatUnit (string)

The unit in which the quantity should be displayed.

FormatNumber (string)

A format string for the number of the quantity.

UseLongNames (bool)

Wether to use the unit's long name instead of the short form.

Outputs

* (double)

The formatted string of that provided unit type.