selectionPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(MP argument, formatting)
(Add selectionVectorDirAndUp to see also)
 
(83 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
|version2= 1.00


|arg= global|= Arguments in MP
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| Search for selection in the object model (first in the memory level, then in geometry LODs).
|game4= tkoh
|version4= 1.00


<br>Returns position in model space. In A1 it returns the initial position of the selection, in A2/3 position of the selection (e.g. when it is animated).
|game5= arma3
|version5= 0.50


<br>If a selection does not exist [0,0,0] is returned. |= Description
|arg= global
____________________________________________________________________________________________


| object '''selectionPosition''' selectionName |= Syntax
|gr1= Object Manipulation


|p1= object: [[Object]] |= Parameter 1
|gr2= Render Time Scope
|p2= selectionName: [[String]] |= Parameter 2


| [[Array]] - [x,y,z] relative position in model space |= Return value
|descr= Returns selection position in model space pertaining to the current animation in [[Simulation vs Render Time Scope|render time scope]].
____________________________________________________________________________________________
When the default syntax is used, command searches first in Memory [[LOD]], then in Geometry LOD, FireGeometry LOD, LandContact LOD, HitPoints LOD and finally in ViewGeometry LOD and returns the first matching find.
The second syntax allows to specify which one of these LODs to search in instead.
{{Feature|important|
Sometimes internally "ViewGeometry" could be equal to "Geometry", and "FireGeometry" could be equal to "ViewGeometry".
In order to pinpoint the actual LOD, use [[allLODs]] and [[LOD_resolutions|LOD resolution]] as argument for selecting the LOD.
}}
 
|s1= object [[selectionPosition]] selectionName
 
|p1= object: [[Object]]
 
|p2= selectionName: [[String]]
 
|r1= [[Array]] - [[Position#PositionRelative|relative position]] in model space. If selection does not exist, [0, 0, 0] is returned.
 
|s2= object [[selectionPosition]] [selectionName, LOD, returnMode]
 
|s2since= arma3 1.50
 
|p21= object: [[Object]]
 
|p22= selectionName: [[String]]
 
|p23= LOD: [[String]] or [[Number]] - can be one of:
* {{hl|"Memory"}}
* {{hl|"Geometry"}}
* {{hl|"FireGeometry"}}
* {{hl|"LandContact"}}
* {{hl|"HitPoints"}}
* {{GVI|arma3|2.06|size= 0.75}} {{hl|"ViewGeometry"}}
When [[Number]] is used, command searches for a LOD with the similar [[LOD resolutions|LOD resolution]]
|p23since= arma3 2.06
 
|p24= returnMode: [[String]] - (Optional, default {{hl|"FirstPoint"}}) can be one of:
* {{hl|"FirstPoint"}}
* {{hl|"AveragePoint"}}
* {{hl|"BoundingBox"}}
 
|p24since= arma3 2.08
 
|r2= [[Array]] - [[Position#PositionRelative|relative position]] in model space. If selection does not exist, [0, 0, 0] is returned. If returnMode is {{hl|"BoundingBox"}}, [[Array]] of [[Array]]s
 
|s3= [[selectionPosition]] [object, selectionName, LODIndex, isVisual, returnMode]
 
|s3since= arma3 2.06
 
|p41= object: [[Object]]


|x1= <code>_inModelPosition = [[player]] [[selectionPosition]] "head_hit";</code> |= Example 1
|p42= selectionName: [[String]]


|x2= <code>_inModelPosition = [[player]] [[selectionPosition]] "pelvis";</code> |= Example 2
|p43= LODIndex: [[Number]] - the index of the target LOD (see [[allLODs]])
|x3= <code>_inModelPosition = [[player]] [[selectionPosition]] "head";</code> |= Example 3
|x4= <code>_inModelPosition = [[player]] [[selectionPosition]] "camera";</code> |= Example 4
____________________________________________________________________________________________


| [[modelToWorld]] |= See also
|p44= isVisual: [[Boolean]] - (Optional, default [[true]]) [[true]] for Render, [[false]] for Simulation [[Simulation_vs_Render_Time_Scope|time scope]]


|p45= returnMode: [[String]] - (Optional, default {{hl|"FirstPoint"}}) can be one of:
* {{hl|"FirstPoint"}}
* {{hl|"AveragePoint"}}
* {{hl|"BoundingBox"}}
|p45since= arma3 2.08
|r3= [[Array]] - [[Position#PositionRelative|relative position]] in model space. If selection does not exist, [0, 0, 0] is returned. If returnMode is {{hl|"BoundingBox"}}, [[Array]] of [[Array]]s
|x1= <sqf>_inModelPosition = player selectionPosition "head_hit";</sqf>
|x2= <sqf>_inModelPosition = player selectionPosition "pelvis";</sqf>
|x3= <sqf>_inModelPosition = player selectionPosition "head";</sqf>
|x4= <sqf>_inModelPosition = player selectionPosition "camera";</sqf>
|x5= <sqf>
stomper selectionPosition ["wheel_1_1", "HitPoints", "FirstPoint"]; // [-0.774058,0.860854,-1.40365]
stomper selectionPosition ["wheel_1_1", "HitPoints", "AveragePoint"]; // [-0.597142,1.35486,-1.58345]
stomper selectionPosition ["wheel_1_1", "HitPoints", "BoundingBox"]; // [[-0.774058,0.860854,-2.07746],[-0.420225,1.84887,-1.08944]]
</sqf>
|seealso= [[selectionVectorDirAndUp]] [[modelToWorld]] [[selectionNames]] [[getAllHitPointsDamage]] [[allLODs]] [[LOD resolutions]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Killzone_Kid
<!-- Note Section BEGIN -->
|timestamp= 20170625151300
<dd class="notedate">Posted on January 5, 2007 - 12:24
|text= Do use the filter that comes with {{Link|#Syntax 2}} to suit your needs. For example [[player]] has 3 selections called "head" and their [[selectionPosition]]s are quite different from each other:
<dt class="note">'''[[User:Giova|Giova]]'''<dd class="note">
<sqf>
To know more selections simply create an eventHandler damage on an object.
player selectionPosition ["head", "Memory"]; // [0.173798,0.330415,1.37783]
<!-- Note Section END -->
player selectionPosition ["head", "FireGeometry"]; // [0.14375,0.206039,1.44689]
</dl>
player selectionPosition ["head", "HitPoints"]; // [0.144257,0.306769,1.53471]
 
</sqf>
<h3 style="display:none">Bottom Section</h3>
}}
[[Category:Scripting Commands|SELECTIONPOSITION]]
[[Category:Scripting Commands ArmA|SELECTIONPOSITION]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 20:46, 16 August 2023

Hover & click on the images for description

Description

Description:
Returns selection position in model space pertaining to the current animation in render time scope. When the default syntax is used, command searches first in Memory LOD, then in Geometry LOD, FireGeometry LOD, LandContact LOD, HitPoints LOD and finally in ViewGeometry LOD and returns the first matching find. The second syntax allows to specify which one of these LODs to search in instead.
Sometimes internally "ViewGeometry" could be equal to "Geometry", and "FireGeometry" could be equal to "ViewGeometry". In order to pinpoint the actual LOD, use allLODs and LOD resolution as argument for selecting the LOD.
Groups:
Object ManipulationRender Time Scope

Syntax 1

Syntax:
object selectionPosition selectionName
Parameters:
object: Object
selectionName: String
Return Value:
Array - relative position in model space. If selection does not exist, [0, 0, 0] is returned.

Syntax 2

Syntax:
object selectionPosition [selectionName, LOD, returnMode]
Parameters:
object: Object
selectionName: String
since Arma 3 logo black.png2.06
LOD: String or Number - can be one of:
  • "Memory"
  • "Geometry"
  • "FireGeometry"
  • "LandContact"
  • "HitPoints"
  • Arma 3 logo black.png2.06 "ViewGeometry"
When Number is used, command searches for a LOD with the similar LOD resolution
since Arma 3 logo black.png2.08
returnMode: String - (Optional, default "FirstPoint") can be one of:
  • "FirstPoint"
  • "AveragePoint"
  • "BoundingBox"
Return Value:
Array - relative position in model space. If selection does not exist, [0, 0, 0] is returned. If returnMode is "BoundingBox", Array of Arrays

Syntax 3

Syntax:
selectionPosition [object, selectionName, LODIndex, isVisual, returnMode]
Parameters:
object: Object
selectionName: String
LODIndex: Number - the index of the target LOD (see allLODs)
isVisual: Boolean - (Optional, default true) true for Render, false for Simulation time scope
since Arma 3 logo black.png2.08
returnMode: String - (Optional, default "FirstPoint") can be one of:
  • "FirstPoint"
  • "AveragePoint"
  • "BoundingBox"
Return Value:
Array - relative position in model space. If selection does not exist, [0, 0, 0] is returned. If returnMode is "BoundingBox", Array of Arrays

Examples

Example 1:
_inModelPosition = player selectionPosition "head_hit";
Example 2:
_inModelPosition = player selectionPosition "pelvis";
Example 3:
_inModelPosition = player selectionPosition "head";
Example 4:
_inModelPosition = player selectionPosition "camera";
Example 5:
stomper selectionPosition ["wheel_1_1", "HitPoints", "FirstPoint"]; // [-0.774058,0.860854,-1.40365] stomper selectionPosition ["wheel_1_1", "HitPoints", "AveragePoint"]; // [-0.597142,1.35486,-1.58345] stomper selectionPosition ["wheel_1_1", "HitPoints", "BoundingBox"]; // [[-0.774058,0.860854,-2.07746],[-0.420225,1.84887,-1.08944]]

Additional Information

See also:
selectionVectorDirAndUp modelToWorld selectionNames getAllHitPointsDamage allLODs LOD resolutions

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
Killzone_Kid - c
Posted on Jun 25, 2017 - 15:13 (UTC)
Do use the filter that comes with Syntax 2 to suit your needs. For example player has 3 selections called "head" and their selectionPositions are quite different from each other:
player selectionPosition ["head", "Memory"]; // [0.173798,0.330415,1.37783] player selectionPosition ["head", "FireGeometry"]; // [0.14375,0.206039,1.44689] player selectionPosition ["head", "HitPoints"]; // [0.144257,0.306769,1.53471]