BIS fnc clampVector: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(created page)
 
m (Some wiki formatting)
 
(14 intermediate revisions by 3 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


<!---|arg= local |Multiplayer Arguments=--->
|descr= Clamps vector values between provided min/max boundaries.


<!---|eff= local |Multiplayer Effects=--->
{{Feature|informative|This function can be used to clamp any [[Array]] of [[Number]]s (even though it is not its main usage).}}


| <pre>/*
|s1= [vector, min, max] call [[BIS_fnc_clampVector]]
Author:
Nelson Duarte


Description:
|p1= vector: [[Vector3D]] - (Optional, default [0,0,0]) the vector to be clamped
Clamps vector between min / max


Parameters:
|p2= min: [[Number]] - (Optional, default 0)
_this: ARRAY
0: ARRAY - The vector to clamp
1: SCALAR - Min value
2: SCALAR - Max value


Returns:
|p3= max: [[Number]] - (Optional, default 0)
ARRAY - Clamped vector
*/</pre>{{Informative|Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]]}} |Description=


|[] call [[BIS_fnc_clampVector]]|Syntax=
|r1= [[Vector3D]] - the clamped ''vector''


|p1= parameter: Datatype - (Optional, default defValue) description |Parameter 1=
|x1= <sqf>
private _newVelocity = [velocity vehicle player, -100, 100] call BIS_fnc_clampVector;
vehicle player setVelocity _newVelocity;
</sqf>


|Datatype - description|Return value=
|seealso= [[BIS_fnc_clamp]] [[vectorNormalized]] [[vectorMultiply]]
 
|x1= <code></code>|Example 1=
 
| |See also=
}}
}}
[[Category:Function Group: Math|{{uc:clampVector}}]]
[[Category:Functions|{{uc:clampVector}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:clampVector}}]]

Latest revision as of 12: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"