ProtoFlux:To String: Difference between revisions

From Resonite Wiki
m Move category tag
m cleanups
Line 14: Line 14:
|}}
|}}


== Usage ==
The '''To String''' node turns various types, including objects, into strings. In general, this will match the string that a [[Display (ProtoFlux)|display node]] displays. Use cases include HUDs that involve numbers, such as turning your FPS into text for a display, or readouts of objects or values.
You can use this node for turning values into strings, even an object. Turning an object into a string is useful for taking what you see in a display node for a value directly into a string object.
You can also use this for huds, like turning your FPS into text for a display, or readouts of objects or values.


== Inputs == <!--T:3-->
== Inputs ==


=== V (Generic) ===
=== V (Generic) ===
Line 29: Line 27:
The locale to use for the output. Defaults to the invariant culture.
The locale to use for the output. Defaults to the invariant culture.


== Outputs == <!--T:3-->
== Outputs ==


=== * (String) ===
=== * (String) ===

Revision as of 03:22, 15 January 2024

To String
V
*
Format
FormatProvider
Strings

The To String node turns various types, including objects, into strings. In general, this will match the string that a display node displays. Use cases include HUDs that involve numbers, such as turning your FPS into text for a display, or readouts of objects or values.

Inputs

V (Generic)

The value to turn into a string.

Format (String)

A Composite Format String.

FormatProvider (IFormatProvider)

The locale to use for the output. Defaults to the invariant culture.

Outputs

* (String)

The value as a string following the format.

Examples