BIS fnc convertUnits: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {{Function|Comments=" to "{{Function|Comments=")
mNo edit summary
Line 8: Line 8:


| Converts values to a target system of units. |DESCRIPTION=
| Converts values to a target system of units. |DESCRIPTION=
Parameter(s):
_this select 0: source value (Scalar)
_this select 1: source unit (Scalar)
0: m (meters)
1: km (kilometers)
2: ms (meters per second)
3: kmh (kilometers per hour)
4: ft (feet)
5: mi (miles)
6: fts (feet per second)
7: mph (miles per hour)
8: nm (nautical miles)
9: kts (knots)
_this select 2: destination unit (Scalar) [optional - default: detected system of units]
_this select 3: destination mode (Scalar) [optional - default: 0]
0: destination value (Scalar)
1: destination text long (String) "5 meters" e.g.
2: destination text short (String) "5 m" e.g.
_this select 4: destination precision factor (Scalar) [optional - default: 1 (uses rounding)]
-1: no changes to converted value
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 59: Line 38:
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>_distString = [500, 0, 5, 1, -1] [[call]] [[BIS_fnc_convertUnits]];</code> |PARAMETER1=
|x1= <code>_distString = [500, 0, 5, 1, -1] [[call]] [[BIS_fnc_convertUnits]];</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 09:28, 25 September 2020

Hover & click on the images for description

Description

Description:
Converts values to a target system of units.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[value, from, to, mode, precision] call BIS_fnc_convertUnits
Parameters:
value: Number - source value
from: Number - source unit. Can be one of:
  • 0: m (meters)
  • 1: km (kilometers)
  • 2: ms (meters per second)
  • 3: kmh (kilometers per hour)
  • 4: ft (feet)
  • 5: mi (miles)
  • 6: fts (feet per second)
  • 7: mph (miles per hour)
  • 8: nm (nautical miles)
  • 9: kts (knots)
to: Number - (Optional, default detected system of units via systemOfUnits) destination unit. See from.
mode: Number - (Optional, default 0) can be one of:
  • 0: destination value (Scalar)
  • 1: destination text long (String) e.g "5 meters"
  • 2: destination text short (String) e.g "5 m"
precision: Number - (Optional, default 1) destination precision factor, -1 for no precision change. cannot be 0
Return Value:
Number or String - converted value

Examples

Example 1:
_distString = [500, 0, 5, 1, -1] call BIS_fnc_convertUnits;

Additional Information

See also:
systemOfUnits

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

Notes

Bottom Section