BIS fnc convertUnits: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
Lou Montana (talk | contribs) (Page filling) |
||
| Line 8: | Line 8: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | Converts values to a target system of units. |= Description | ||
Parameter(s): | Parameter(s): | ||
| Line 33: | Line 30: | ||
_this select 4: destination precision factor (Scalar) [optional - default: 1 (uses rounding)] | _this select 4: destination precision factor (Scalar) [optional - default: 1 (uses rounding)] | ||
-1: no changes to converted value | -1: no changes to converted value | ||
____________________________________________________________________________________________ | |||
| [value, from, to, mode, precision] call [[BIS_fnc_convertUnits]] |= Syntax | |||
|p1= value: [[Number]] - source value |= Parameter 1 | |||
|p2= 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) |= Parameter 2 | |||
|p3= to: [[Number]] - (Optional, default detected system of units ''via'' [[systemOfUnits]]) destination unit. See ''from''. |= Parameter 3 | |||
| | |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" |= Parameter 4 | |||
| | |p5= precision: [[Number]] - (Optional, default 1) destination precision factor, -1 for no precision change. '''cannot be 0''' |= Parameter 5 | ||
| |= Return value | | [[Number]] or [[String]] - converted value |= Return value | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code></code> |= | |x1= <code>_distString = [500, 0, 5, 1, -1] [[call]] [[BIS_fnc_convertUnits]];</code> |= Parameter 1 | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| |= See also | | [[systemOfUnits]] |= See also | ||
}} | }} | ||
Revision as of 23:26, 29 April 2018
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