BIS fnc convertUnits: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) 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...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| tkoh | | tkoh | ||
|1.00 | |1.00 | ||
|gr1 = Math | |gr1 = Math | ||
| Converts values to a target system of units. | | Converts values to a target system of units. | ||
| [value, from, to, mode, precision] call [[BIS_fnc_convertUnits]] | | [value, from, to, mode, precision] call [[BIS_fnc_convertUnits]] | ||
|p1= value: [[Number]] - source value | |p1= value: [[Number]] - source value | ||
|p2= from: [[Number]] - source unit. Can be one of: | |p2= from: [[Number]] - source unit. Can be one of: | ||
| Line 23: | Line 23: | ||
* 7: mph (miles per hour) | * 7: mph (miles per hour) | ||
* 8: nm (nautical miles) | * 8: nm (nautical miles) | ||
* 9: kts (knots) | * 9: kts (knots) | ||
|p3= to: [[Number]] - (Optional, default detected system of units ''via'' [[systemOfUnits]]) destination unit. See ''from''. | |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: | |p4= mode: [[Number]] - (Optional, default 0) can be one of: | ||
* 0: destination value (Scalar) | * 0: destination value (Scalar) | ||
* 1: destination text long (String) e.g "5 meters" | * 1: destination text long (String) e.g "5 meters" | ||
* 2: destination text short (String) e.g "5 m" | * 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''' | |p5= precision: [[Number]] - (Optional, default 1) destination precision factor, -1 for no precision change. '''cannot be 0''' | ||
| [[Number]] or [[String]] - converted value | | [[Number]] or [[String]] - converted value | ||
|x1= <code>_distString = [500, 0, 5, 1, -1] [[call]] [[BIS_fnc_convertUnits]];</code> | |x1= <code>_distString = [500, 0, 5, 1, -1] [[call]] [[BIS_fnc_convertUnits]];</code> | ||
| [[systemOfUnits]] | | [[systemOfUnits]] | ||
}} | }} | ||
Revision as of 22:37, 17 January 2021
Description
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