Class Units

Units display utilities for Editor.

Inheritance

System.Object

Units

Namespace: FlaxEditor.Utilities

Assembly: FlaxEngine.CSharp.dll

Syntax

public static class Units : Object

Fields

AutomaticUnitsFormatting

If set to true, the distance unit is chosen on the magnitude, otherwise it's meters.

Declaration

public static bool AutomaticUnitsFormatting

Field Value

System.Boolean

Meters2Units

Factor of units per meter.

Declaration

public static readonly float Meters2Units

Field Value

System.Single

SeparateValueAndUnit

Add a space between numbers and units for readability.

Declaration

public static bool SeparateValueAndUnit

Field Value

System.Boolean

UseUnitsFormatting

False to always show game units without any postfix.

Declaration

public static bool UseUnitsFormatting

Field Value

System.Boolean

Methods

Unit(String)

Return the unit according to user settings.

Declaration

public static string Unit(string unit)

Parameters

System.String unit The unit name.

Returns

System.String The formatted text.