BIS fnc clampVector: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function|= Comments " to "{{Function|Comments= ")
(Page filling)
Line 5: Line 5:
|1.00|Game version=
|1.00|Game version=


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


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


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


Description:
|p1= vector: [[Vector3D]] - (Optional, default [0,0,0]) the vector to be clamped |Parameter 1=
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>{{placeholder}}<!-- Remove this after fill-in --> |Description=


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


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


|Datatype - description|Return value=
| [[BIS_fnc_clamp]] |See also=
 
|x1= <code></code>|Example 1=
 
| |See also=
}}
}}


[[Category:Function Group: Math|{{uc:clampVector}}]]
[[Category:Function Group: Math|{{uc:clampVector}}]]
[[Category:Functions|{{uc:clampVector}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:clampVector}}]]

Revision as of 17:36, 26 June 2020

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:
Uncategorised

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

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=154793"