BIS fnc clampVector: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Add seealso links)
m (Some wiki formatting)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|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).}} |Description=
{{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]] |Syntax=
|s1= [vector, min, max] call [[BIS_fnc_clampVector]]


|p1= vector: [[Vector3D]] - (Optional, default [0,0,0]) the vector to be clamped |Parameter 1=
|p1= vector: [[Vector3D]] - (Optional, default [0,0,0]) the vector to be clamped


|p2= min: [[Number]] - (Optional, default 0)
|p2= min: [[Number]] - (Optional, default 0)
Line 17: Line 18:
|p3= max: [[Number]] - (Optional, default 0)
|p3= max: [[Number]] - (Optional, default 0)


| [[Vector3D]] - the clamped ''vector'' |Return value=
|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> |Example 1=
private _newVelocity = [velocity vehicle player, -100, 100] call BIS_fnc_clampVector;
vehicle player setVelocity _newVelocity;
</sqf>


| [[BIS_fnc_clamp]] [[vectorNormalized]] [[vectorMultiply]] |See also=
|seealso= [[BIS_fnc_clamp]] [[vectorNormalized]] [[vectorMultiply]]
}}
}}
[[Category:Function Group: Math|{{uc:clampVector}}]]

Latest revision as of 13:07, 13 July 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

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

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

Examples

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

Additional Information

See also:
BIS_fnc_clamp vectorNormalized vectorMultiply

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_clampVector&oldid=327749"