getMarkerPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.00|Game version=
|1.00


|gr1 = Markers |GROUP1=
|gr1 = Markers


|eff= local |Multiplayer Arguments=
|eff= local


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


| [[getMarkerPos]] markerName |SYNTAX=
| [[getMarkerPos]] markerName


|p1= markerName: [[String]] |PARAMETER1=
|p1= markerName: [[String]]


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


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


|p21= [markerName, preserveElevation]: [[Array]] |PARAMETER21=
|p21= [markerName, preserveElevation]: [[Array]] |PARAMETER21=
Line 26: Line 26:
|p23= preserveElevation (Optional): [[Boolean]] Default: [[false]]  |PARAMETER23=
|p23= preserveElevation (Optional): [[Boolean]] Default: [[false]]  |PARAMETER23=


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


|x1= <code>_mPos1 = [[getMarkerPos]] "markerOne";</code> |EXAMPLE1=
|x1= <code>_mPos1 = [[getMarkerPos]] "markerOne";</code>


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


| [[setMarkerPos]], [[setMarkerPosLocal]] |SEEALSO=
| [[setMarkerPos]], [[setMarkerPosLocal]]
}}
}}



Revision as of 01:40, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns marker position. See also setMarkerPos.
This command is identical to markerPos.
Groups:
Markers

Syntax

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

Alternative Syntax

Syntax:
getMarkerPos [markerName, preserveElevation] Template:Since
Parameters:
[markerName, preserveElevation]: Array
markerName: String
preserveElevation (Optional): Boolean 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:
setMarkerPossetMarkerPosLocal

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

Bottom Section