BIS fnc clamp: Difference between revisions

Latest revision as of 16:49, 21 May 2023

Hover & click on the images for description

Description:: Clamps provided value within min..max range.
ⓘ
This function is for readability; for performance, directly use min and max.
Execution:: call
Groups:: Math

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
Example 2:: [5, 0, 10] call BIS_fnc_clamp; // 0.0098 ms 0 max 5 min 10; // 0.0011 ms - about 10x faster

: 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
+{{RV|type=function
 |game1= arma3
+|version1= 1.00
-|version1= 1.00
+|gr1= Math
 |descr= Clamps provided value within min..max range.
+{{Feature|informative|This function is for readability; for performance, directly use [[min]] and [[max]].}}
 |s1= [value, min, max] call [[BIS_fnc_clamp]]
 |p1= value: [[Number]] - value to be clamped
 |p2= min: [[Number]] - (Optional, default 0) lower limit
 |p3= max: [[Number]] - (Optional, default 0) upper limit
 |r1= [[Number]] - the clamped value
-|x1= <code> [5, 0, 10] [[call]] [[BIS_fnc_clamp]]; {{cc|returns 5}}
+|x1= <sqf notrim>
-  [0, 0, 10] [[call]] [[BIS_fnc_clamp]]; {{cc|returns 0}}
+ [5, 0, 10] call BIS_fnc_clamp;	// returns 5
-[10, 0, 10] [[call]] [[BIS_fnc_clamp]]; {{cc|returns 10}}
+  [0, 0, 10] call BIS_fnc_clamp;	// returns 0
-[-5, 0, 10] [[call]] [[BIS_fnc_clamp]]; {{cc|returns 0}}
+[10, 0, 10] call BIS_fnc_clamp;	// returns 10
-[15, 0, 10] [[call]] [[BIS_fnc_clamp]]; {{cc|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
+</sqf>
- [5, '''10''', 3] [[call]] [[BIS_fnc_clamp]]; {{cc|returns 10}}
+|x2= <sqf>
-</code>
+[5, 0, 10] call BIS_fnc_clamp;	// 0.0098 ms
+max 5 min 10;					// 0.0011 ms - about 10x faster
+</sqf>
-|seealso= [[:Category:Function Group: Math]] [[:Category:Command Group: Math]]
+|seealso= [[min]] [[max]]
 }}