createMarker: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
No edit summary
 
(37 intermediate revisions by 3 users not shown)
Line 22: Line 22:
|descr= Creates a new map marker at the given position. The marker will be created for every connected player as well as all JIP players. The marker name has to be unique; the command will be ignored if a marker with the given name already exists.
|descr= Creates a new map marker at the given position. The marker will be created for every connected player as well as all JIP players. The marker name has to be unique; the command will be ignored if a marker with the given name already exists.


{{Feature|important|The marker will be visible only once at least [[markerType]] has been defined:
{{Feature|important|
<div><code>_marker <nowiki>=</nowiki> [[createMarker]] ["markername", [[player]]]; {{cc|Not visible yet.}}
The marker will be visible only once at least [[markerType]] has been defined:
_marker [[setMarkerType]] "hd_dot"; {{cc|Visible.}}</code></div>}}
<sqf>
_marker = createMarker ["markername", player]; // Not visible yet.
_marker setMarkerType "hd_dot"; // Visible.</sqf>
}}


{{Feature|Informative|If the marker position is given in 3D format, the <tt>z</tt>-coordinate is stored with the marker and will be used when the marker is passed to commands such as [[createVehicle]], [[createUnit]], [[createAgent]], [[createMine]] or [[setVehiclePosition]].<br>When a marker is manually placed in the editor, <tt>z</tt> is always 0, which means the marker is placed on the ground. But when the player places a marker on the map in game, it is placed at sea level, so the <tt>z</tt>-coordinate of that marker is {{ic|[[-]][[getTerrainHeightASL]] [[markerPos]] &lt;USERMARKER&gt;}}.}}
{{Feature|informative|If the marker position is given in 3D format, the {{hl|z}}-coordinate is stored with the marker and will be used when the marker is passed to commands such as [[createVehicle]], [[createUnit]], [[createAgent]], [[createMine]] or [[setVehiclePosition]].<br>When a marker is manually placed in the editor, {{hl|z}} is always 0, which means the marker is placed on the ground. But when the player places a marker on the map in game, it is placed at sea level, so the {{hl|z}}-coordinate of that marker is <sqf inline>-getTerrainHeightASL markerPos "userMarker";</sqf>.}}


|mp= {{Feature|Informative|'''Multiplayer optimisation:''' Global marker commands always broadcast the ''entire'' marker state over the network. As such, the number of network messages exchanged when creating or editing a marker can be reduced by performing all but the last operation using local marker commands, then using a global marker command for the last change (and subsequent global broadcast of all changes applied to the marker).}}
|mp= {{Feature|informative|
'''Multiplayer optimisation:''' Global marker commands always broadcast the ''entire'' marker state over the network.
As such, the number of network messages exchanged when creating or editing a marker can be reduced by performing all but the last operation using local marker commands, then using a global marker command for the last change (and subsequent global broadcast of all changes applied to the marker).
}}
 
|pr= [[setMarkerDrawPriority]] sorts [[allMapMarkers]] from least to most priority. Before {{GVI|arma3|2.18|size= 0.75}} [[createMarker]]/[[createMarkerLocal]] did '''not''' care about drawing priority and added the created marker to the end of the array, making it top priority. Running [[setMarkerDrawPriority]] again sorted this issue.


|s1= [[createMarker]] [name, position, channel, creator]
|s1= [[createMarker]] [name, position, channel, creator]


|p1= '''name''': [[String]] - The marker's name, used to reference the marker in scripts.
|p1= name: [[String]] - the marker's name, used to reference the marker in scripts.


|p2= '''position''': [[Array]] or [[Object]] - [[Position2D]], [[PositionAGL]] or [[Object]]. In case of object, the object's [[PositionWorld]] is used.
|p2= position: [[Array]] or [[Object]] - [[Position#Introduction|Position2D]], [[Position#PositionAGL|PositionAGL]] or [[Object]]. In case of an object, the object's model [0,0,0] is used.


|p3= '''channel''' (Optional): [[Number]] (See also [[Channel IDs]]) - The marker channel for MP {{GVI|arma3|2.02}}
|p3= channel: [[Number]] - (Optional, default -1) the marker channel - see [[Channel IDs]] (for multiplayer)
|p3since= arma3 2.02


|p4= '''creator''' (Optional): [[Object]] - The marker creator for MP {{GVI|arma3|2.02}}
|p4= creator: [[Object]] - (Optional, default [[objNull]]) the marker creator (for multiplayer)
|p4since= arma3 2.02


|r1= [[String]] - The marker's name or empty string if the marker name is not unique.
|r1= [[String]] - the marker's name or empty string if the marker name is not unique.


|x1= <code>_marker1 = [[createMarker]] ["Marker1", [[position]] [[player]]];</code>
|x1= <sqf>_marker1 = createMarker ["Marker1", position player];</sqf>


|x2= <code>_marker2 = [[createMarker]] ["Marker2", [[player]]]; {{codecomment|// since {{arma3}} v1.50}}</code>
|x2= <sqf>_marker2 = createMarker ["Marker2", player]; // since {{arma3}} 1.50</sqf>


|seealso= [[createMarkerLocal]] [[deleteMarker]] [[BIS_fnc_markerToString]] [[BIS_fnc_stringToMarker]]
|seealso= [[createMarkerLocal]] [[deleteMarker]] [[BIS_fnc_markerToString]] [[BIS_fnc_stringToMarker]]
}}
}}


<dl class="command_description">
{{Note
|user= Soldia
|timestamp= 20150919210200
|text= [[createMarker]] accepts an object as position parameter as well . You could try this with the following code (both SP/MP)


<dt></dt>
<sqf>
<dd class="notedate">Posted on September 19, 2015 - 21:02 (UTC)</dd>
_markerstr = createMarker ["markername", player];
<dt class="note">[[User:Soldia (JP)|Soldia (JP)]]</dt>
_markerstr setMarkerShape "RECTANGLE";
<dd class="note">
_markerstr setMarkerSize [100, 100];
createMarker accepts an object as position parameter as well (A3 - 1.50.131969). You could try this with the following code (both SP/MP)
</sqf>
|game= arma3
|version= 1.50
}}


<code>_markerstr = [[createMarker]] ["markername", [[player]]];
{{Note
_markerstr [[setMarkerShape]] "RECTANGLE";
|user= X39
_markerstr [[setMarkerSize]] [100, 100];</code>
|timestamp= 20180528115700
</dd>
|text= In {{arma3}}, one can create markers which are deletable by the user by prefixing the name with {{hl|_USER_DEFINED}}.


<dt><dt>
Example:
<dd class="notedate">Posted on May 28, 2018 - 11:57 (UTC)</dd>
<sqf>createMarker "_USER_DEFINED someMarkerName"</sqf>
<dt class="note">[[User:x39|x39]]</dt>
}}
<dd class="note">
In Arma 3, one can create markers which are deletable by the user by prefixing the name with `_USER_DEFINED`.


Example: <code>[[createMarker]] "_USER_DEFINED someMarkerName"</code>
{{Note
</dd>
|user= 7erra
<dt></dt>
|timestamp= 20190503155300
<dd class="notedate">Posted on April 11, 2019 - 07:10 (UTC)</dd>
|text= 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]]
<dt class="note">[[User:killzone_kid|killzone_kid]]</dt>
|game= arma3
<dd class="note">
|version= 1.92
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>


<dt><dt>
{{Note
<dd class="notedate">Posted on May 3, 2019 - 15:53 (UTC)</dd>
|user= Tirpitz
<dt class="note">[[User:7erra|7erra]]</dt>
|timestamp= 20210126224200
<dd class="note">
|text= When creating a marker with the name format: "_USER_DEFINED #n1/n2/n3".
{{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>
<dt></dt>
<dd class="notedate">Posted on January 26, 2021 - 22:42 (UTC)</dd>
<dt class="note">[[User:tirpitz|tirpitz]]</dt>
<dd class="note">
When creating a marker with the name format: "_USER_DEFINED #n1/n2/n3".
n1 can be used to set the owner, n2 I think is an incrementing index to ensure markers are unique, to this end also mangle some more characters onto the end of the string, and n3 is the channel ID the marker is in.  
n1 can be used to set the owner, n2 I think is an incrementing index to ensure markers are unique, to this end also mangle some more characters onto the end of the string, and n3 is the channel ID the marker is in.  
<code>_markerName {{=}} format ["_USER_DEFINED #%1/%2/%3" , clientOwner,_index, _ChannelID];  
<sqf>
_markerName = format ["_USER_DEFINED #%1/%2/%3" , clientOwner,_index, _ChannelID];
_marker = createMarkerLocal [_markerName, _pos];
</sqf>
}}


_marker {{=}} createMarkerLocal [_markerName, _pos];
{{Note
</code>
|user= POLPOX
 
|timestamp= 20230708160357
</dd>
|text= If you use the letter "/" in the name, it may break the channel visibilities (especially in MP).
 
Possible reason is described above by Tirpitz, the engine may confuse which channel the marker belongs to after the "/".
</dl>
}}

Latest revision as of 11:57, 1 November 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GEGlobal
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 connected player as well as all JIP players. The marker name has to be unique; the command will be ignored if a marker with the given name already exists.
⚠
The marker will be visible only once at least markerType has been defined:
_marker = createMarker ["markername", player]; // Not visible yet. _marker setMarkerType "hd_dot"; // Visible.
ⓘ
If the marker position is given in 3D format, the z-coordinate is stored with the marker and will be used when the marker is passed to commands such as createVehicle, createUnit, createAgent, createMine or setVehiclePosition.
When a marker is manually placed in the editor, z is always 0, which means the marker is placed on the ground. But when the player places a marker on the map in game, it is placed at sea level, so the z-coordinate of that marker is -getTerrainHeightASL markerPos "userMarker";.
Multiplayer:
ⓘ
Multiplayer optimisation: Global marker commands always broadcast the entire marker state over the network. As such, the number of network messages exchanged when creating or editing a marker can be reduced by performing all but the last operation using local marker commands, then using a global marker command for the last change (and subsequent global broadcast of all changes applied to the marker).
Problems:
setMarkerDrawPriority sorts allMapMarkers from least to most priority. Before Arma 3 logo black.png2.18 createMarker/createMarkerLocal did not care about drawing priority and added the created marker to the end of the array, making it top priority. Running setMarkerDrawPriority again sorted this issue.
Groups:
Markers

Syntax

Syntax:
createMarker [name, position, channel, creator]
Parameters:
name: String - the marker's name, used to reference the marker in scripts.
position: Array or Object - Position2D, PositionAGL or Object. In case of an object, the object's model [0,0,0] is used.
since Arma 3 logo black.png2.02
channel: Number - (Optional, default -1) the marker channel - see Channel IDs (for multiplayer)
since Arma 3 logo black.png2.02
creator: Object - (Optional, default objNull) the marker creator (for multiplayer)
Return Value:
String - the marker's name or empty string if the marker name is not unique.

Examples

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

Additional Information

See also:
createMarkerLocal deleteMarker BIS_fnc_markerToString BIS_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
Soldia - c
Posted on Sep 19, 2015 - 21:02 (UTC)
Arma 3 logo black.png1.50

createMarker accepts an object as position parameter as well . You could try this with the following code (both SP/MP)

_markerstr = createMarker ["markername", player]; _markerstr setMarkerShape "RECTANGLE"; _markerstr setMarkerSize [100, 100];

X39 - c
Posted on May 28, 2018 - 11:57 (UTC)
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"
7erra - c
Posted on May 03, 2019 - 15:53 (UTC)
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

Tirpitz - c
Posted on Jan 26, 2021 - 22:42 (UTC)
When creating a marker with the name format: "_USER_DEFINED #n1/n2/n3". n1 can be used to set the owner, n2 I think is an incrementing index to ensure markers are unique, to this end also mangle some more characters onto the end of the string, and n3 is the channel ID the marker is in.
_markerName = format ["_USER_DEFINED #%1/%2/%3" , clientOwner,_index, _ChannelID]; _marker = createMarkerLocal [_markerName, _pos];
POLPOX - c
Posted on Jul 08, 2023 - 16:03 (UTC)
If you use the letter "/" in the name, it may break the channel visibilities (especially in MP). Possible reason is described above by Tirpitz, the engine may confuse which channel the marker belongs to after the "/".
Retrieved from "https://community.bistudio.com/wiki?title=createMarker&oldid=370100"