{"name":"BIS_fnc_clamp","operator":null,"title":"BIS fnc clamp","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_clamp","revid":341317,"updated":"2023-05-21T15:49:57Z","groups":["Math"],"status":"ok","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.00"}],"since":{"game":"arma3","name":"Arma 3","version":"1.00"},"arma3_since":"1.00","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"description":"Clamps provided value within min..max range.\n\n> [!NOTE]\n> This function is for readability; for performance, directly use min and max.","syntaxes":[{"syntax":"[value, min, max] call BIS_fnc_clamp","since":null,"effect":null,"exec":null,"params":[{"name":"value","type":"Number","optional":false,"default":null,"description":"value to be clamped","types":["Number"],"since":null,"text":"value: Number - value to be clamped"},{"name":"min","type":"Number","optional":true,"default":"0","description":"lower limit","types":["Number"],"since":null,"text":"min: Number - (Optional, default 0) lower limit"},{"name":"max","type":"Number","optional":true,"default":"0","description":"upper limit","types":["Number"],"since":null,"text":"max: Number - (Optional, default 0) upper limit"}],"returns":{"type":"Number","types":["Number"],"description":"the clamped value","text":"Number - the clamped value"}}],"examples":[{"text":"```sqf\n [5, 0, 10] call BIS_fnc_clamp;    // returns 5\n [0, 0, 10] call BIS_fnc_clamp;    // returns 0\n[10, 0, 10] call BIS_fnc_clamp;    // returns 10\n[-5, 0, 10] call BIS_fnc_clamp;    // returns 0\n[15, 0, 10] call BIS_fnc_clamp;    // returns 10\n [5, 10, 3] call BIS_fnc_clamp;    // returns 10\n```","code":[" [5, 0, 10] call BIS_fnc_clamp;\t// returns 5\n [0, 0, 10] call BIS_fnc_clamp;\t// returns 0\n[10, 0, 10] call BIS_fnc_clamp;\t// returns 10\n[-5, 0, 10] call BIS_fnc_clamp;\t// returns 0\n[15, 0, 10] call BIS_fnc_clamp;\t// returns 10\n [5, 10, 3] call BIS_fnc_clamp;\t// returns 10"]},{"text":"```sqf\n[5, 0, 10] call BIS_fnc_clamp;    // 0.0098 ms\n0 max 5 min 10;                    // 0.0011 ms - about 10x faster\n```","code":["[5, 0, 10] call BIS_fnc_clamp;\t// 0.0098 ms\n0 max 5 min 10;\t\t\t\t\t// 0.0011 ms - about 10x faster"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["min","max"],"notes":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Math","Functions","Introduced with Arma 3 version 1.00"],"docblock":null,"filled_from_docblock":[]}