Public Member Functions
	Length (float value, LengthUnit unit)
float	ConvertTo (LengthUnit unit)
	Converts the length to a value in the provided units.
double	PreciselyConvertTo (LengthUnit unit)
	Converts the length to a double value in the provided units.

Static Public Member Functions
static float	ConvertToMeters (float length, LengthUnit unit)
	Converts the provided length value to a value in meters.
static float	ConvertMetersTo (float meters, LengthUnit unit)
	Converts the provided meter value to a value in the provided units.
static double	PreciselyConvertMetersTo (double meters, LengthUnit unit)
	Converts the provided meter value to a double value in the provided units.
static Length	operator* (Length a, float scalar)
	Multiplies a Length by some scalar value.
static Length	operator+ (Length a, Length b)
	Adds two Length values together.
static Length	operator- (Length a, Length b)
	Subtracts one Length value from another Length value.

Properties
float	ToInches `[get]`
	The Length, converted to inches.
float	ToFeet `[get]`
	The Length, converted to feet.
float	ToYards `[get]`
	The Length, converted to yards.
float	ToFurlongs `[get]`
	The Length, converted to furlongs.
float	ToMiles `[get]`
	The Length, converted to miles.
float	ToMillimeters `[get]`
	The Length, converted to millimeters.
float	ToMegaBeardSeconds `[get]`
	The Length, converted to mega-beard-seconds.
float	ToCentimeters `[get]`
	The Length, converted to centimeters.
float	ToAttoparsecs `[get]`
	The Length, converted to attoparsecs.
float	ToMeters `[get]`
	The Length, converted to meters.
float	ToSmoots `[get]`
	The Length, converted to smoots.
float	ToKilometers `[get]`
	The Length, converted to kilometers.

Constructor & Destructor Documentation

◆ Length()

TiltFive.Length.Length	(	float	value,
		LengthUnit	unit )

inline

Member Function Documentation

◆ ConvertMetersTo()

float TiltFive.Length.ConvertMetersTo	(	float	meters,
		LengthUnit	unit )

inlinestatic

Converts the provided meter value to a value in the provided units.

Parameters

meters	The provided length in meters.
unit	The provided length units.

Returns: The length, in the provided units.

◆ ConvertTo()

float TiltFive.Length.ConvertTo ( LengthUnit unit )

inline

Converts the length to a value in the provided units.

Parameters

unit	The provided length units.

Returns: The length, in the provided units.

◆ ConvertToMeters()

float TiltFive.Length.ConvertToMeters	(	float	length,
		LengthUnit	unit )

inlinestatic

Converts the provided length value to a value in meters.

Parameters

length	The provided length.
unit	The provided length units.

Returns: The length, in meters.

◆ operator*()

Length TiltFive.Length.operator*	(	Length	a,
		float	scalar )

static

Multiplies a Length by some scalar value.

Parameters

a
scalar

Returns

◆ operator+()

Length TiltFive.Length.operator+	(	Length	a,
		Length	b )

static

Adds two Length values together.

Parameters

a
b

Returns

◆ operator-()

Length TiltFive.Length.operator-	(	Length	a,
		Length	b )

static

Subtracts one Length value from another Length value.

Parameters

a
b

Returns

◆ PreciselyConvertMetersTo()

double TiltFive.Length.PreciselyConvertMetersTo	(	double	meters,
		LengthUnit	unit )

inlinestatic

Converts the provided meter value to a double value in the provided units.

Parameters

meters	The provided length in meters.
unit	The provided length units.

Returns: The length, in the provided units.

Performs the conversion calculation using double arithmetic to reduce floating-point rounding errors. This may be less performant, so Drink Responsibly™. /remarks>

◆ PreciselyConvertTo()

double TiltFive.Length.PreciselyConvertTo ( LengthUnit unit )

inline

Converts the length to a double value in the provided units.

Parameters

unit	The provided length units.

Returns: The length, in the provided units.

Performs the conversion calculation using double arithmetic to reduce floating-point rounding errors. This may be less performant, so Drink Responsibly™. /remarks>

Property Documentation

◆ ToAttoparsecs

float TiltFive.Length.ToAttoparsecs

get

The Length, converted to attoparsecs.

◆ ToCentimeters

float TiltFive.Length.ToCentimeters

get

The Length, converted to centimeters.

◆ ToFeet

float TiltFive.Length.ToFeet

get

The Length, converted to feet.

◆ ToFurlongs

float TiltFive.Length.ToFurlongs

get

The Length, converted to furlongs.

◆ ToInches

float TiltFive.Length.ToInches

get

The Length, converted to inches.

◆ ToKilometers

float TiltFive.Length.ToKilometers

get

The Length, converted to kilometers.

◆ ToMegaBeardSeconds

float TiltFive.Length.ToMegaBeardSeconds

get

The Length, converted to mega-beard-seconds.

◆ ToMeters

float TiltFive.Length.ToMeters

get

The Length, converted to meters.

◆ ToMiles

float TiltFive.Length.ToMiles

get

The Length, converted to miles.

◆ ToMillimeters

float TiltFive.Length.ToMillimeters

get

The Length, converted to millimeters.

◆ ToSmoots

float TiltFive.Length.ToSmoots

get

The Length, converted to smoots.

◆ ToYards

float TiltFive.Length.ToYards

get

The Length, converted to yards.

The documentation for this struct was generated from the following file:

Runtime/Utility/Length.cs

Public Member Functions

Static Public Member Functions

Properties

Constructor & Destructor Documentation

◆ Length()

Member Function Documentation

◆ ConvertMetersTo()

◆ ConvertTo()

◆ ConvertToMeters()

◆ operator*()

◆ operator+()

◆ operator-()

◆ PreciselyConvertMetersTo()

◆ PreciselyConvertTo()

Property Documentation

◆ ToAttoparsecs

◆ ToCentimeters

◆ ToFeet

◆ ToFurlongs

◆ ToInches

◆ ToKilometers

◆ ToMegaBeardSeconds

◆ ToMeters

◆ ToMiles

◆ ToMillimeters

◆ ToSmoots

◆ ToYards