ProtoFlux:ToString

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.

If you are looking to take a string and make it into a value instead, try Parse.

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

• 
  Four examples of converting various primitives to string. Three of the examples use Standard Numeric Format Strings.
• 
  Four examples of converting various objects to string. Note how, in general, the output matches what the display node outputs.