Click or drag to resize

CostTypeFormat Method

Formats the value into a human friendly string.

Namespace:  KSPDev.GUIUtils.TypeFormatters
Assembly:  KSPDev_Utils.1.0 (in KSPDev_Utils.1.0.dll) Version: 1.0 for KSP v1.6+
Syntax
C#
Copy
public static string Format(
	double value,
	string format = null
)
Request Example View Source

Parameters

value
Type: SystemDouble
The numeric value to format.
format (Optional)
Type: SystemString
The specific float number format to use. If the format is not specified, then it's choosen basing on the value.

Return Value

Type: String
A formatted and localized string
Remarks

The method tries to keep the resulted string meaningful and as short as possible. For this reason the big values may be scaled down and/or rounded.

There is no well established unit for measuring the costs in the game. However, there is a commonly used literal that denotes the costs: √. This literal is used as the base (and the only) unit name. It's assumed that the values below 0.01 don't makes sense from the financial perspective, so they are not attempted to be presented.

Examples
Copy
Debug.Log(CostType.Format(0.4));
// Prints: "Cost is: √ 0.40"
Debug.Log(CostType.Format(0.41));
// Prints: "Cost is: √ 0.41"
Debug.Log(CostType.Format(1.0));
// Prints: "Cost is: √ 1.00"
Debug.Log(CostType.Format(1.41));
// Prints: "Cost is: √ 1.41"
Debug.Log(CostType.Format(1234.555));
// Prints: "Cost is: √ 1,234.56"
Examples
Copy
Debug.Log(CostType.Format(1234.5678, format: "0.0000"));
// Prints: "√ 1234.5678"
Debug.Log(CostType.Format(1234.5678, format: "#,##0.00"));
// Prints: "√ 1,234.57"
See Also