vectorMagnitude: Difference between revisions

Latest revision as of 17:33, 18 March 2025

1.22

Hover & click on the images for description

Description

Description:: Magnitude of a 3D vector.

2.14
Since 2.14 any count of numbers is valid.
Before 2.14, the argument had to be vector 3D, or 2.00 2D (With z coordinate defaulted to 0)
Groups:: Math - Vectors

Syntax

Syntax:: vectorMagnitude vector
Parameters:: vector: Array of Numbers
Return Value:: Number

Examples

Example 1:: _size = vectorMagnitude [0,3,4]; // returns 5
Example 2:: _speed = vectorMagnitude velocity player; // return velocity of player in m/s _speed = (vectorMagnitude velocity player) * 3.6; // return velocity of player in km/h _speed = (vectorMagnitude velocity player) * 2.23694; // return velocity of player in mph

Additional Information

See also:: vectorAdd vectorDiff vectorCrossProduct vectorDotProduct vectorCos vectorMagnitudeSqr vectorMultiply vectorDistance vectorDistanceSqr vectorDir vectorUp setVectorDir setVectorUp setVectorDirAndUp vectorNormalized vectorFromTo matrixMultiply matrixTranspose

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

: Posted on 28 Jun, 2014
ffur2007slx2_5: 1.22 Algorithm:
Vector = [x,y,z]; Result = sqrt ((x ^ 2) + (y ^ 2) + (z ^ 2));
It is recommended to use vectorMagnitude instead of BIS_fnc_magnitude.

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
+|version1= 1.22
-|1.22|= Game version
+|gr2= Math - Vectors
-____________________________________________________________________________________________
+|descr=Magnitude of a 3D vector.<br>
+{{Feature|GVI|arma3|2.14|Since {{GVI|arma3|2.14|size= 0.75}} any count of numbers is valid.<br>
+Before {{GVI|arma3|2.14|size= 0.75}}, the argument had to be vector 3D, or {{GVI|arma3|2.00|size= 0.75}} 2D (With z coordinate defaulted to 0)}}
-|Magnitude of a 3D vector. |= Description
-____________________________________________________________________________________________
-| '''vectorMagnitude''' vector |= Syntax
+|s1= [[vectorMagnitude]] vector
-|p1= vector: [[Array]] |= Parameter 1
+|p1= vector: [[Array]] of [[Number]]s
-| [[Number]] |= Return value
+|r1= [[Number]]
-____________________________________________________________________________________________
-|x1= <code>_size = vectorMagnitude [0,0,2]</code> |= Example 1
-____________________________________________________________________________________________
-|  |= See also
+|x1= <sqf>_size = vectorMagnitude [0,3,4]; // returns 5</sqf>
+|x2= <sqf>
+_speed = vectorMagnitude velocity player;				// return velocity of player in m/s
+_speed = (vectorMagnitude velocity player) * 3.6;		// return velocity of player in km/h
+_speed = (vectorMagnitude velocity player) * 2.23694;	// return velocity of player in mph
+</sqf>
+|seealso= [[vectorAdd]] [[vectorDiff]] [[vectorCrossProduct]] [[vectorDotProduct]] [[vectorCos]] [[vectorMagnitudeSqr]] [[vectorMultiply]] [[vectorDistance]] [[vectorDistanceSqr]] [[vectorDir]] [[vectorUp]] [[setVectorDir]] [[setVectorUp]] [[setVectorDirAndUp]] [[vectorNormalized]] [[vectorFromTo]] [[matrixMultiply]] [[matrixTranspose]]
 }}
-<h3 style="display:none">Notes</h3>
 <dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+<dt></dt>
+<dd class="notedate">Posted on 28 Jun, 2014</dd>
+<dt class="note">[[User:ffur2007slx2_5| ffur2007slx2_5]]</dt>
+<dd class="note">
+{{GVI|arma3|1.22}} Algorithm:
+<sqf>
+Vector = [x,y,z];
+Result = sqrt ((x ^ 2) + (y ^ 2) + (z ^ 2));
+</sqf>
+It is recommended to use [[vectorMagnitude]] instead of [[BIS_fnc_magnitude]].
 </dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]