createMarker: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(different height of manual marker placement)
m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2")
(10 intermediate revisions by 3 users not shown)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Creates a new map marker at the given position. The marker will be created for every player on network as well as JIP. The marker name has to be unique, if a marker with the given name exists, the command will be ignored. Use [[deleteMarker]] to delete global marker.<br />
| Creates a new map marker at the given position. '''The marker will be created for every player on network as well as JIP'''. The marker name has to be unique, if a marker with the given name exists, the command will be ignored. Use [[deleteMarker]] to delete global marker.<br />
<br />
<br />
{{Important|The marker will be visible if you define ''at least'' [[markerShape]] and [[markerType]] settings:
{{Important|The marker will be visible if you define ''at least'' [[markerType]] settings:
<code>_markerName {{=}} [[createMarker]] ["markername", [_Xpos, _Ypos]];
<div><code>_markerName {{=}} [[createMarker]] ["markername", [[player]]];
_markerName [[setMarkerShape]] "ICON";
_markerName [[setMarkerType]] "hd_dot";</code></div>}}
_markerName [[setMarkerType]] "hd_dot";</code>
}}
<br>
<br>
{{Informative|If position is given in 3D format, the <tt>z</tt> coordinate is stored with the marker and will be used when marker is passed to commands like [[createVehicle]], [[createUnit]], [[createAgent]], [[createMine]], [[setVehiclePosition]] for example. When marker is manually placed in the editor, <tt>z</tt> is 0, which means it is placed on the ground. However when user manually places marker on the map in game, it is placed on the water, so <tt>z</tt> of the marker will be: <tt>[[-]][[getTerrainHeightASL]] [[markerPos]] &lt;USERMARKER&gt;</tt>}} |Description=
{{Informative|If position is given in 3D format, the <tt>z</tt> coordinate is stored with the marker and will be used when marker is passed to commands like [[createVehicle]], [[createUnit]], [[createAgent]], [[createMine]], [[setVehiclePosition]] for example. When marker is manually placed in the editor, <tt>z</tt> is 0, which means it is placed on the ground. However when user manually places marker on the map in game, it is placed on the water, so <tt>z</tt> of the marker will be: <tt>[[-]][[getTerrainHeightASL]] [[markerPos]] &lt;USERMARKER&gt;</tt>}} |Description=
Line 26: Line 24:
|p2= name: [[String]] |Parameter 2=
|p2= name: [[String]] |Parameter 2=


|p3= position: [[Array]] or [[Object]] - format position: [[Position2D]], [[PositionAGL]] or [[Object]] |Parameter 3=
|p3= position: [[Array]] or [[Object]] - format position: [[Position2D]], [[PositionAGL]] or [[Object]] (object's [[PositionWorld]] is used)|Parameter 3=


| [[String]] |Return value=
| [[String]] |Return value=
Line 40: Line 38:
[[setMarkerBrush]], [[setMarkerColor]], [[setMarkerDir]]
[[setMarkerBrush]], [[setMarkerColor]], [[setMarkerDir]]
[[setMarkerPos]], [[setMarkerShape]], [[setMarkerSize]]
[[setMarkerPos]], [[setMarkerShape]], [[setMarkerSize]]
[[setMarkerText]], [[setMarkerType]], [[setMarkerAlpha]] |See also=
[[setMarkerText]], [[setMarkerType]], [[setMarkerAlpha]], [[BIS_fnc_markerToString]], [[BIS_fnc_stringToMarker]] |See also=
}}
}}


Line 74: Line 72:
[[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP Elite |{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on April 11, 2019 - 07:10 (UTC)</dd>
<dt class="note">[[User:killzone_kid|killzone_kid]]</dt>
<dd class="note">
Passing object as argument for position may produce slightly different position than when explicitly obtaining object position via position commands, as in
<code>[[createMarker]] ["marker1", _obj]</code>
may slightly differ from
<code>[[createMarker]] ["marker1", [[ASLtoAGL]] [[getPosASL]] _obj]</code>
This is because when object passed as position, the raw [[getPosWorld]] is used
<code>[[createMarker]] ["marker1", [[ASLtoAGL]] [[getPosWorld]] _obj]</code> will produce identical result in this case, but may not be what is required
</dd>
</dl>
<!-- DISCONTINUE Notes -->
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on May 3, 2019 - 15:53 (UTC)</dd>
<dt class="note">[[User:7erra|7erra]]</dt>
<dd class="note">
{{GVI|arma3|1.92}} There is a new function with which you can create a marker with all settings applied in one step: [[BIS_fnc_stringToMarker]] and [[BIS_fnc_stringToMarkerLocal]]
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 00:41, 10 January 2020

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Creates a new map marker at the given position. The marker will be created for every player on network as well as JIP. The marker name has to be unique, if a marker with the given name exists, the command will be ignored. Use deleteMarker to delete global marker.

The marker will be visible if you define at least markerType settings:
_markerName = createMarker ["markername", player]; _markerName setMarkerType "hd_dot";


If position is given in 3D format, the z coordinate is stored with the marker and will be used when marker is passed to commands like createVehicle, createUnit, createAgent, createMine, setVehiclePosition for example. When marker is manually placed in the editor, z is 0, which means it is placed on the ground. However when user manually places marker on the map in game, it is placed on the water, so z of the marker will be: -getTerrainHeightASL markerPos <USERMARKER>
Multiplayer:
createMarker is global, use createMarkerLocal if you want to create a local marker
Groups:
Uncategorised

Syntax

Syntax:
createMarker [name, position]
Parameters:
[name, position]: Array
name: String
position: Array or Object - format position: Position2D, PositionAGL or Object (object's PositionWorld is used)
Return Value:
String

Examples

Example 1:
_marker1 = createMarker ["Marker1", position player];
Example 2:
_marker2 = createMarker ["Marker2", player]; // since Arma 3 v1.50

Additional Information

See also:
allMapMarkersdeleteMarkercreateMarkerLocalallMapMarkers setMarkerBrushsetMarkerColorsetMarkerDir setMarkerPossetMarkerShapesetMarkerSize setMarkerTextsetMarkerTypesetMarkerAlphaBIS_fnc_markerToStringBIS_fnc_stringToMarker

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

Notes

Posted on September 19, 2015 - 21:02 (UTC)
Soldia (JP)
createMarker accepts an object as position parameter as well (A3 - 1.50.131969). You could try this with the following code (both SP/MP) _markerstr = createMarker ["markername", player]; _markerstr setMarkerShape "RECTANGLE"; _markerstr setMarkerSize [100, 100];
Posted on May 28, 2018 - 11:57 (UTC)
x39
In Arma 3, one can create markers which are deletable by the user by prefixing the name with `_USER_DEFINED`. Example: createMarker "_USER_DEFINED someMarkerName"


Bottom Section

Posted on April 11, 2019 - 07:10 (UTC)
killzone_kid
Passing object as argument for position may produce slightly different position than when explicitly obtaining object position via position commands, as in createMarker ["marker1", _obj] may slightly differ from createMarker ["marker1", ASLtoAGL getPosASL _obj] This is because when object passed as position, the raw getPosWorld is used createMarker ["marker1", ASLtoAGL getPosWorld _obj] will produce identical result in this case, but may not be what is required
Posted on May 3, 2019 - 15:53 (UTC)
7erra
Arma 3 logo black.png1.92 There is a new function with which you can create a marker with all settings applied in one step: BIS_fnc_stringToMarker and BIS_fnc_stringToMarkerLocal