vectorDirVisual: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "[[Image:" to "[[File:")
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.32


|1.32|Game version=
|arg= global


|arg= global |=  
|gr1= Math - Vectors
|gr2= Render Time Scope


|gr1= Math - Vectors |GROUP1=
|descr= [[File:arma3_object-vectors.jpg|thumb|right|An object with its [[vectorDirVisual]], [[vectorUpVisual]] and [[vectorSideVisual]] (vectors not to scale)]]
|gr2= Render Time Scope |GROUP2=
Returns an object's direction vector in world space and [[Simulation vs Render Time Scope|render time scope]].
____________________________________________________________________________________________


| Return object's normalized direction vector in world space (<tt>[x,y,z]</tt>) in render time scope.  
{{Feature|important|The vector is '''not necessarily [[vectorNormalized|normalized]]'''. The [[vectorMagnitude|magnitude]] of the vector depends on the [[getObjectScale|object's scale]].}}
* A unit facing North would return <tt>[0,1,0]</tt>
* A unit facing East would return <tt>[1,0,0]</tt>
* A unit facing South would return <tt>[0,-1,0]</tt>
* A unit facing West would return <tt>[-1,0,0]</tt> |DESCRIPTION=
____________________________________________________________________________________________


| '''vectorDirVisual''' objectName |SYNTAX=
For an object facing one of the cardinal directions on perfectly flat ground (parallel to the XY-plane of the world space), [[vectorDirVisual]] returns simple values:
* {{hl|[0, 1, 0]}} if the object is facing directly north
* {{hl|[1, 0, 0]}} if the object is facing directly east
* {{hl|[0, -1, 0]}} if the object is facing directly south
* {{hl|[-1, 0, 0]}} if the object is facing directly west


|p1= objectName: [[Object]] |PARAMETER1=
|s1= [[vectorDirVisual]] object


| [[Array]] - format [[Vector3D]] |RETURNVALUE=
|p1= object: [[Object]]
____________________________________________________________________________________________


|x1= <code>_dirVector = [[vectorDirVisual]] _unit;</code> |EXAMPLE1=
|r1= [[Array]] format [[Vector3D]]
____________________________________________________________________________________________


| [[vectorModelToWorldVisual]], [[vectorDir]], [[vectorUpVisual]], [[vectorUp]], [[setVectorDir]], [[setVectorUp]], [[setVectorDirAndUp]], [[vectorDiff]], [[vectorAdd]], [[vectorMultiply]], [[vectorCrossProduct]], [[vectorDistance]], [[vectorMagnitudeSqr]], [[vectorDistanceSqr]], [[vectorCos]], [[vectorMagnitude]], [[vectorDotProduct]], [[vectorNormalized]], [[vectorFromTo]]|SEEALSO=
|x1= <sqf>_vecDirVis = vectorDirVisual MyObject;</sqf>


|seealso= [[vectorModelToWorldVisual]] [[vectorDir]] [[vectorSide]] [[vectorSideVisual]] [[vectorUpVisual]] [[vectorUp]] [[setVectorDir]] [[setVectorUp]] [[setVectorDirAndUp]] [[vectorDiff]] [[vectorAdd]] [[vectorMultiply]] [[vectorCrossProduct]] [[vectorDistance]] [[vectorMagnitudeSqr]] [[vectorDistanceSqr]] [[vectorCos]] [[vectorMagnitude]] [[vectorDotProduct]] [[vectorNormalized]] [[vectorFromTo]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
{{GameCategory|arma3|New_Scripting_Commands_List}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 23:11, 20 November 2023

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

Description

Description:
An object with its vectorDirVisual, vectorUpVisual and vectorSideVisual (vectors not to scale)

Returns an object's direction vector in world space and render time scope.

⚠
The vector is not necessarily normalized. The magnitude of the vector depends on the object's scale.

For an object facing one of the cardinal directions on perfectly flat ground (parallel to the XY-plane of the world space), vectorDirVisual returns simple values:

  • [0, 1, 0] if the object is facing directly north
  • [1, 0, 0] if the object is facing directly east
  • [0, -1, 0] if the object is facing directly south
  • [-1, 0, 0] if the object is facing directly west
Groups:
Math - VectorsRender Time Scope

Syntax

Syntax:
vectorDirVisual object
Parameters:
object: Object
Return Value:
Array format Vector3D

Examples

Example 1:
_vecDirVis = vectorDirVisual MyObject;

Additional Information

See also:
vectorModelToWorldVisual vectorDir vectorSide vectorSideVisual vectorUpVisual vectorUp setVectorDir setVectorUp setVectorDirAndUp vectorDiff vectorAdd vectorMultiply vectorCrossProduct vectorDistance vectorMagnitudeSqr vectorDistanceSqr vectorCos vectorMagnitude vectorDotProduct vectorNormalized vectorFromTo

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=vectorDirVisual&oldid=349933"