markerPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(49 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|MARKERPOS]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.96|MARKERPOS]]
[[Category:Scripting Commands ArmA|MARKERPOS]]
[[Category:Command Group: Markers|MARKERPOS]]


{{Command|= Comments
|game1= ofp
____________________________________________________________________________________________
|version1= 1.46


| ofp |= Game name
|game2= ofpe
|1.5|= Game version
|version2= 1.00
|eff= local|Multiplayer Arguments=
____________________________________________________________________________________________


| Returns marker position<br><br>
|game3= arma1
{{Informative | This command is identical to [[getMarkerPos]]}} |DESCRIPTION=
|version3= 1.00
____________________________________________________________________________________________


| '''markerPos''' markerName |SYNTAX=
|game4= arma2
|version4= 1.00


|p1= markerName: [[String]] |PARAMETER1=
|game5= arma2oa
|version5= 1.50


| [[Array]] - format [x,y,0] |RETURNVALUE=
|game6= tkoh
|version6= 1.00


| s2='''markerPos''' [markerName, preserveElevation] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;''(Since Arma 3 v1.93)''|SYNTAX2=
|game7= arma3
|version7= 0.50


|p21= [markerName, preserveElevation]: [[Array]] |PARAMETER21=
|gr1= Markers
|p22= markerName: [[String]] |PARAMETER22=
|p23= preserveElevation (Optional): [[Boolean]] Default: [[false]]  |PARAMETER23=


|r2= [[Array]] - format [[PositionAGL]] if ''preserveElevation'' is [[true]] or [x,y,0] if ''preserveElevation'' is [[false]] |RETURNVALUE2=
|descr= Returns marker position. See also [[setMarkerPos]].
____________________________________________________________________________________________
 
|x1= <code>_mPos1 = [[markerPos]] "markerOne";</code> |EXAMPLE1=
|x2= <code>_mPos2 = [[markerPos]] ["markerTwo", [[true]]];</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[setMarkerPos]], [[setMarkerPosLocal]] |SEEALSO=
|alias= [[getMarkerPos]]


|s1= [[markerPos]] markerName
|p1= markerName: [[String]]
|r1= [[Array]] format [[Position#PositionAGL|PositionAGL]] - [x, y, '''0'''], z is always 0
|s2= [[markerPos]] [markerName, preserveElevation]
|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]]
|x1= <sqf>_mPos1 = markerPos "markerOne";</sqf>
|x2= <sqf>_mPos2 = markerPos ["markerTwo", true];</sqf>
|seealso= [[setMarkerPos]] [[setMarkerPosLocal]]
}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on March 17, 2014
<dt><dt>
<dt class="note">'''[[User:Waffle SS.|Waffle SS.]]'''
<dd class="notedate">Posted on 2016-09-01 - 12:42 (UTC)</dd>
<dd class="note"> Position's Z coordinate will always be 0."
<dt class="note">[[User:Demellion|Demellion]]</dt>
<dd class="note">
To accomplish getting the altitude of a marker before the alternative syntax introduced in A3 v1.93, you can do a workaround using [[setMarkerDir]] as it accepts any number (above 360 or below -360):
<sqf>
"myMarker" setMarkerPos [200, 200];
"myMarker" setMarkerDir 1640;
</sqf>
 
After, setting player position as an example:
<sqf>player setPosASL [(markerPos "myMarker") select 0, (markerPos "myMarker") select 1, (markerDir "myMarker")]</sqf>
</dd>


<!-- Note Section END -->
</dl>
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[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 11:34, 3 September 2024

Hover & click on the images for description

Description

Description:
Returns marker position. See also setMarkerPos.
Alias:
getMarkerPos
Groups:
Markers

Syntax

Syntax:
markerPos markerName
Parameters:
markerName: String
Return Value:
Array format PositionAGL - [x, y, 0], z is always 0

Alternative Syntax

Syntax:
markerPos [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 = markerPos "markerOne";
Example 2:
_mPos2 = markerPos ["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
Posted on 2016-09-01 - 12:42 (UTC)
Demellion
To accomplish getting the altitude of a marker before the alternative syntax introduced in A3 v1.93, you can do a workaround using setMarkerDir as it accepts any number (above 360 or below -360):
"myMarker" setMarkerPos [200, 200]; "myMarker" setMarkerDir 1640;
After, setting player position as an example:
player setPosASL [(markerPos "myMarker") select 0, (markerPos "myMarker") select 1, (markerDir "myMarker")]