getMarkerPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
mNo edit summary
 
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
|version2= 1.00


|gr1 = Markers |GROUP1=
|game3= arma1
|version3= 1.00


|eff= local |Multiplayer Arguments=
|game4= arma2
|version4= 1.00


| Returns marker position. See also [[setMarkerPos]].
|game5= arma2oa
{{Informative | This command is identical to [[markerPos]].}} |DESCRIPTION=
|version5= 1.50


| [[getMarkerPos]] markerName |SYNTAX=
|game6= tkoh
|version6= 1.00


|p1= markerName: [[String]] |PARAMETER1=
|game7= arma3
|version7= 0.50


| [[Array]] - format [x,y,0] |RETURNVALUE=
|gr1= Markers


|s2= [[getMarkerPos]] [markerName, preserveElevation] {{Since|arma3|1.93|y}} |SYNTAX2=
|eff= local


|p21= [markerName, preserveElevation]: [[Array]] |PARAMETER21=
|descr= Returns marker position.


|p22= markerName: [[String]] |PARAMETER22=
|alias= [[markerPos]]


|p23= preserveElevation (Optional): [[Boolean]] Default: [[false]]  |PARAMETER23=
|s1= [[getMarkerPos]] markerName


|r2= [[Array]] - format [[PositionAGL]] if ''preserveElevation'' is [[true]] or [x,y,0] if ''preserveElevation'' is [[false]] |RETURNVALUE2=
|p1= markerName: [[String]]


|x1= <code>_mPos1 = [[getMarkerPos]] "markerOne";</code> |EXAMPLE1=
|r1= [[Array]] format [[Position#PositionAGL|PositionAGL]] - format [x,y,0]


|x2= <code>_mPos2 = [[getMarkerPos]] ["markerTwo", [[true]]];</code> |EXAMPLE2=
|s2= [[getMarkerPos]] [markerName, preserveElevation]


| [[setMarkerPos]], [[setMarkerPosLocal]] |SEEALSO=
|s2since= arma3 1.94
}}
 
|p21= markerName: [[String]]
 
|p22= preserveElevation: [[Boolean]] (Optional, default [[false]])
 
|r2= [[Array]] format [[Position#PositionAGL|PositionAGL]] - if ''preserveElevation'' is [[true]] or [x,y,0] if ''preserveElevation'' is [[false]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>_mPos1 = getMarkerPos "markerOne";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>_mPos2 = getMarkerPos ["markerTwo", true];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[setMarkerPos]] [[setMarkerPosLocal]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 12:08, 28 September 2023

Hover & click on the images for description

Description

Description:
Returns marker position.
Alias:
markerPos
Groups:
Markers

Syntax

Syntax:
getMarkerPos markerName
Parameters:
markerName: String
Return Value:
Array format PositionAGL - format [x,y,0]

Alternative Syntax

Syntax:
getMarkerPos [markerName, preserveElevation]
Parameters:
markerName: String
preserveElevation: Boolean (Optional, default false)
Return Value:
Array format PositionAGL - if preserveElevation is true or [x,y,0] if preserveElevation is false

Examples

Example 1:
_mPos1 = getMarkerPos "markerOne";
Example 2:
_mPos2 = getMarkerPos ["markerTwo", true];

Additional Information

See also:
setMarkerPos setMarkerPosLocal

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