BIS fnc convertUnits: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
m (Text replacement - " |s1=[" to " |s1= [")
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| tkoh
|game1= tkoh
|version1= 1.00


|1.00
|game2= arma3
|version2= 0.50


|gr1 = Math
|gr1= Math


| Converts values to a target system of units.
|descr= Converts values to a target system of units.


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


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


| [[Number]] or [[String]] - converted value
|r1= [[Number]] or [[String]] - converted value


|x1= <code>_distString = [500, 0, 5, 1, -1] [[call]] [[BIS_fnc_convertUnits]];</code>
|x1= <sqf>private _distString = [500, 0, 5, 1, -1] call BIS_fnc_convertUnits;</sqf>


| [[systemOfUnits]]
|seealso= [[systemOfUnits]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:convertUnits}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:convertUnits}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:convertUnits}}]]

Latest revision as of 23:11, 12 July 2022

tkoh logo small.png1.00Arma 3 logo black.png0.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_convertUnits&oldid=327279"