OpenTTD Source: UnitConversion Struct Reference

OpenTTD Source 12.2

Public Member Functions | Data Fields
UnitConversion Struct Reference

Helper for unit conversion. More...

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

## Data Fields
int | multiplier
| Amount to multiply upon conversion.
int | shift
| Amount to shift upon conversion.

## Detailed Description

Helper for unit conversion.

Definition at line 661 of file strings.cpp.

## Member Function Documentation

## ◆ FromDisplay()

int64 UnitConversion::FromDisplay | ( | int64 | input,
|  | bool | round = `true`,
|  | int64 | 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 683 of file strings.cpp.

Referenced by ConvertDisplaySpeedToKmhishSpeed(), and ConvertDisplaySpeedToSpeed().

## ◆ ToDisplay()

int64 UnitConversion::ToDisplay | ( | int64 | 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 671 of file strings.cpp.

References shift.

Referenced by ConvertKmhishSpeedToDisplaySpeed(), and ConvertSpeedToDisplaySpeed().

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

- src/strings.cpp