PressureType Class

Localized message formatting class for a numeric value that represents a pressure. The resulted message may have a unit specification.

Inheritance Hierarchy

SystemObject
KSPDev.GUIUtils.TypeFormattersPressureType

Namespace: KSPDev.GUIUtils.TypeFormatters
Assembly: KSPDev_Utils.2.0 (in KSPDev_Utils.2.0.dll) Version: 2.0 for KSP v1.8+

Syntax

Copy

public sealed class PressureType

Request Example View Source

The PressureType type exposes the following members.

Constructors

	Name	Description
	PressureType	Constructs an object from a numeric value.

Top

Methods

	Name	Description
	Format	Formats the value into a human friendly string with a unit specification.
	ToString	Returns a string formatted as a human friendly pressure specification. (Overrides ObjectToString.)

Top

Operators

	Name	Description
	(Double to PressureType)	Coverts a numeric value into a type object.
	(PressureType to Double)	Converts a type object into a numeric value.

Top

Fields

	Name	Description
	kiloPascal	Localized suffix for the "kilopascal" units. Scale x1.
	KilopascalLocTag	Localization tag for the "kilopascal" units.
	value	A wrapped numeric value.

Top

Remarks

Use it as a generic parameter when creating a LocalizableMessage descendants.

The class uses the unit name localizations from the stock module ModuleEnviroSensor. In case of this module is deprecated or the tags are changed, the default English values will be used for the unit names.

Examples

Copy

public class PressureTypeDemo1 : PartModule {
  static readonly Message<PressureType> msg1 = new Message<PressureType>(
      "#TypeDemo_msg1", defaultTemplate: "Pressure is: <<1>>");

  void Show() {
    Debug.Log(msg1.Format(0.051));
    // Prints: "Pressure is: 0.051 kPa"
    Debug.Log(msg1.Format(0.45));
    // Prints: "Pressure is: 0.45 kPa"
    Debug.Log(msg1.Format(95.45));
    // Prints: "Pressure is: 95.5 kPa"
    Debug.Log(msg1.Format(120.45));
    // Prints: "Pressure is: 121 kPa"
    Debug.Log(msg1.Format(9535.45));
    // Prints: "Pressure is: 9,536 kPa"
  }
}

Examples

Copy

Debug.Log(PressureType.Format(0.051));
// Prints: "Pressure is: 0.051 kPa"
Debug.Log(PressureType.Format(0.45));
// Prints: "Pressure is: 0.45 kPa"
Debug.Log(PressureType.Format(95.45));
// Prints: "Pressure is: 95.5 kPa"
Debug.Log(PressureType.Format(120.45));
// Prints: "Pressure is: 121 kPa"
Debug.Log(PressureType.Format(9535.45));
// Prints: "Pressure is: 9,536 kPa"

Examples

Copy

Debug.Log(PressureType.Format(1234.5678, format: "0.0000"));
// Prints: "1234.5678 kPa"
Debug.Log(PressureType.Format(1234.5678, format: "0.00"));
// Prints: "1234.57 kPa"
Debug.Log(PressureType.Format(1234.5678, format: "#,##0.00"));
// Prints: "1,234.57 kPa"