BIS fnc convertUnits: Difference between revisions

Latest revision as of 23:11, 12 July 2022

1.00

0.50

Hover & click on the images for description

Description

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

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:: private _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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| tkoh |Game name=
+|game1= tkoh
+|version1= 1.00
-|1.00|Game version=
+|game2= arma3
-____________________________________________________________________________________________
+|version2= 0.50
-| Converts values to a target system of units. |DESCRIPTION=
+|gr1= Math
-____________________________________________________________________________________________
-| [value, from, to, mode, precision] call [[BIS_fnc_convertUnits]] |SYNTAX=
+|descr= Converts values to a target system of units.
-|p1= value: [[Number]] - source value |PARAMETER1=
+|s1= [value, from, to, mode, precision] call [[BIS_fnc_convertUnits]]
+|p1= value: [[Number]] - source value
 |p2= from: [[Number]] - source unit. Can be one of:
@@ Line 24: / Line 25: @@
 * 7: mph (miles per hour)
 * 8: nm (nautical miles)
-* 9: kts (knots) |PARAMETER2=
+* 9: kts (knots)
-|p3= to: [[Number]] - (Optional, default detected system of units ''via'' [[systemOfUnits]]) destination unit. See ''from''. |PARAMETER3=
+|p3= to: [[Number]] - (Optional, default detected system of units ''via'' [[systemOfUnits]]) destination unit. See ''from''.
 |p4= 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" |PARAMETER4=
+* 2: destination text short (String) e.g "5 m"
-|p5= precision: [[Number]] - (Optional, default 1) destination precision factor, -1 for no precision change. '''cannot be 0''' |PARAMETER5=
+|p5= precision: [[Number]] - (Optional, default 1) destination precision factor, -1 for no precision change. '''cannot be 0'''
-| [[Number]] or [[String]] - converted value |RETURNVALUE=
+|r1= [[Number]] or [[String]] - converted value
-____________________________________________________________________________________________
-|x1= <code>_distString = [500, 0, 5, 1, -1] [[call]] [[BIS_fnc_convertUnits]];</code> |EXAMPLE1=
+|x1= <sqf>private _distString = [500, 0, 5, 1, -1] call BIS_fnc_convertUnits;</sqf>
-____________________________________________________________________________________________
-| [[systemOfUnits]] |SEEALSO=
+|seealso= [[systemOfUnits]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Functions|{{uc:convertUnits}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:convertUnits}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:convertUnits}}]]