BIS fnc convertUnits: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Page filling)
m (template:command argument fix)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Converts values to a target system of units. |= Description
| Converts values to a target system of units. |DESCRIPTION=


Parameter(s):
Parameter(s):
Line 32: Line 32:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [value, from, to, mode, precision] call [[BIS_fnc_convertUnits]] |= Syntax
| [value, from, to, mode, precision] call [[BIS_fnc_convertUnits]] |SYNTAX=


|p1= value: [[Number]] - source value |= Parameter 1
|p1= value: [[Number]] - source value |= Parameter 1
Line 57: Line 57:
|p5= precision: [[Number]] - (Optional, default 1) destination precision factor, -1 for no precision change. '''cannot be 0''' |= Parameter 5
|p5= precision: [[Number]] - (Optional, default 1) destination precision factor, -1 for no precision change. '''cannot be 0''' |= Parameter 5


| [[Number]] or [[String]] - converted value |= Return value
| [[Number]] or [[String]] - converted value |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 63: Line 63:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[systemOfUnits]] |= See also
| [[systemOfUnits]] |SEEALSO=
}}
}}



Revision as of 11:26, 7 April 2019


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