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.
int64 FromDisplay (int64 input, bool round=true) const
 Convert the displayed value back into a value of OpenTTD's internal unit.

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 562 of file strings.cpp.


Member Function Documentation

int64 UnitConversion::FromDisplay ( int64  input,
bool  round = true 
) 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 or not.
Returns:
The converted value.

Definition at line 583 of file strings.cpp.

References shift.

Referenced by ConvertDisplaySpeedToSpeed().

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 572 of file strings.cpp.

References shift.

Referenced by ConvertSpeedToDisplaySpeed(), and FormatString().


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

Generated on Fri May 27 04:21:29 2011 for OpenTTD by  doxygen 1.6.1