BIS fnc clampVector: Difference between revisions

Latest revision as of 12:07, 13 July 2022

Hover & click on the images for description

Description:: Clamps vector values between provided min/max boundaries.
ⓘ
This function can be used to clamp any Array of Numbers (even though it is not its main usage).
Execution:: call
Groups:: Vectors

Syntax:: [vector, min, max] call BIS_fnc_clampVector
Parameters:: vector: Vector3D - (Optional, default [0,0,0]) the vector to be clamped
: min: Number - (Optional, default 0)
: max: Number - (Optional, default 0)
Return Value:: Vector3D - the clamped vector

Example 1:: private _newVelocity = [velocity vehicle player, -100, 100] call BIS_fnc_clampVector; vehicle player setVelocity _newVelocity;

: 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: @@
 {{RV|type=function
-| arma3
+|game1= arma3
+|version1= 1.00
-|1.00
 |gr1= Vectors
-| Clamps vector values between provided min/max boundaries.
+|descr= Clamps vector values between provided min/max boundaries.
-{{Informative | This function can be used to clamp any [[Array]] of [[Number]]s (even though it is not its main usage).}}
+{{Feature|informative|This function can be used to clamp any [[Array]] of [[Number]]s (even though it is not its main usage).}}
-| [vector, min, max] call [[BIS_fnc_clampVector]]
+|s1= [vector, min, max] call [[BIS_fnc_clampVector]]
 |p1= vector: [[Vector3D]] - (Optional, default [0,0,0]) the vector to be clamped
@@ Line 19: / Line 18: @@
 |p3= max: [[Number]] - (Optional, default 0)
-| [[Vector3D]] - the clamped ''vector''
+|r1= [[Vector3D]] - the clamped ''vector''
-|x1= <code>[[private]] _newVelocity = [<nowiki/>[[velocity]] [[vehicle]] [[player]], -100, 100] [[call]] [[BIS_fnc_clampVector]];
+|x1= <sqf>
-[[vehicle]] [[player]] [[setVelocity]] _newVelocity;</code>
+private _newVelocity = [velocity vehicle player, -100, 100] call BIS_fnc_clampVector;
+vehicle player setVelocity _newVelocity;
+</sqf>
-| [[BIS_fnc_clamp]] [[vectorNormalized]] [[vectorMultiply]]
+|seealso= [[BIS_fnc_clamp]] [[vectorNormalized]] [[vectorMultiply]]
 }}