BIS fnc clamp: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) (Page filling) |
Lou Montana (talk | contribs) m (Fix return value) |
||
| Line 13: | Line 13: | ||
|p3= max: [[Number]] - (Optional, default 0) upper limit | |p3= max: [[Number]] - (Optional, default 0) upper limit | ||
| [[Number]] - the clamped value | |r1= [[Number]] - the clamped value | ||
|x1= <code> [5, 0, 10] [[call]] [[BIS_fnc_clamp]]; {{cc|returns 5}} | |x1= <code> [5, 0, 10] [[call]] [[BIS_fnc_clamp]]; {{cc|returns 5}} | ||
| Line 27: | Line 27: | ||
}} | }} | ||
[[Category:Function Group: Math|{{uc:clamp}}]] | [[Category:Function Group: Math|{{uc:clamp}}]] | ||
Revision as of 16:20, 18 September 2020
Description
- Description:
- Clamps provided value within min..max range.
- Execution:
- call
- Groups:
- Uncategorised
Syntax
- Syntax:
- [value, min, max] call BIS_fnc_clamp
- Parameters:
- value: Number - value to be clamped
- min: Number - (Optional, default 0) lower limit
- max: Number - (Optional, default 0) upper limit
- Return Value:
- Number - the clamped value
Examples
- Example 1:
[5, 0, 10] call BIS_fnc_clamp; // returns 5 [0, 0, 10] call BIS_fnc_clamp; // returns 0 [10, 0, 10] call BIS_fnc_clamp; // returns 10 [-5, 0, 10] call BIS_fnc_clamp; // returns 0 [15, 0, 10] call BIS_fnc_clamp; // returns 10 [5, 10, 3] call BIS_fnc_clamp; // returns 10
Additional Information
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