OpenTTD Source: UnitConversion Struct Reference

OpenTTD Source 15.3

Public Member Functions | Data Fields
UnitConversion Struct Reference

Helper for unit conversion. More...

## Public Member Functions
int64_t | ToDisplay (int64_t input, bool round=true) const
| Convert value from OpenTTD's internal unit into the displayed value.
int64_t | FromDisplay (int64_t input, bool round=true, int64_t divider=1) const
| Convert the displayed value back into a value of OpenTTD's internal unit.

## Data Fields
double | factor
| Amount to multiply or divide upon conversion.

## Detailed Description

Helper for unit conversion.

Definition at line 809 of file strings.cpp.

## Member Function Documentation

## ◆ FromDisplay()

int64_t UnitConversion::FromDisplay | ( | int64_t | input,
|  | bool | round = `true`,
|  | int64_t | divider = `1`
| ) |  | const
| inline

Convert the displayed value back into a value of OpenTTD's internal unit.

Parameters

  input | The input to convert.
  round | Whether to round the value up or not.
  divider | Divide the return value by this.

Returns
  The converted value.

Definition at line 832 of file strings.cpp.

Referenced by ConvertDisplaySpeedToKmhishSpeed(), and ConvertDisplaySpeedToSpeed().

## ◆ ToDisplay()

int64_t UnitConversion::ToDisplay | ( | int64_t | input,
|  | bool | round = `true`
| ) |  | const
| inline

Convert value from OpenTTD's internal unit into the displayed value.

Parameters

  input | The input to convert.
  round | Whether to round the value or not.

Returns
  The converted value.

Definition at line 818 of file strings.cpp.

Referenced by ConvertKmhishSpeedToDisplaySpeed(), ConvertSpeedToDisplaySpeed(), and FormatString().

## Field Documentation

## ◆ factor

double UnitConversion::factor

Amount to multiply or divide upon conversion.

Definition at line 810 of file strings.cpp.

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

- src/strings.cpp