Difference between revisions of "allMapMarkers"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (add command group Markers)
(see also)
 
(15 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma3 |= Game name
+
| arma3 |Game name=
  
|0.50|= Game version
+
|0.50|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Return all markers in map. |= Description
+
| Returns all markers in map including user placed markers (_USER_DEFINED #). <br><br>
 +
Since Arma 3 v1.57.134377 User defined markers have the following name format: <br><tt>_USER_DEFINED #<PlayerID>/<MarkerID>/<ChannelID></tt> where:
 +
* <PlayerID> - unique network id of the player in [[String]] format, also available as [[String]] in the 6th param in [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerConnected | "PlayerConnected"]] and [[Arma_3:_Event_Handlers/addMissionEventHandler#PlayerDisconnected|"PlayerDisconnected"]] EHs
 +
* <MarkerID> - a marker counter id
 +
* <ChannelID> - id of the chat channel on which marker was placed (see [[currentChannel]])
 +
For custom waypoint position (LShift+LMB) see [[customWaypointPosition]]
 +
|DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| '''allMapMarkers''' |= Syntax
+
| '''allMapMarkers''' |SYNTAX=
  
| [[Array]] |= RETURNVALUE
+
| [[Array]] of [[String]]s|RETURNVALUE=  
  
 +
|x1= <code>_markers = [[allMapMarkers]];</code>
  
|x1= <code>
+
returns: ["marker1","_USER_DEFINED #2/0"]|EXAMPLE1=  
</code>|= EXAMPLE1
 
  
 +
|x2= <code>{
 +
  [[private]] "_a";
 +
  _a = [[toArray]] _x;
 +
  _a [[resize]] 15;
 +
  [[if]] ([[toString]] _a == "_USER_DEFINED #") [[then]] {
 +
    [[deleteMarker]] _x;
 +
  }
 +
} [[forEach]] [[allMapMarkers]];</code> |EXAMPLE2=
 +
 +
|x3= <code>[[if]] (_someString [[in]] [[allMapMarkers]]) [[then]] {
 +
  [[hint]] (_someString [[valuea_plus_valueb|+]] " is a valid marker name");
 +
};
 +
</code> |EXAMPLE3=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= SEEALSO
+
| [[createMarker]], [[deleteMarker]], [[customWaypointPosition]] |SEEALSO=  
  
|  |= MPBEHAVIOUR
+
|  |MPBEHAVIOUR=  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
}}
 
}}
Line 29: Line 48:
 
<dl class='command_description'>
 
<dl class='command_description'>
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
 +
 +
<dd class="notedate">Posted on March 17, 2014
 +
<dt class="note">'''[[User:Waffle SS.|Waffle SS.]]'''
 +
<dd class="note">'''A3 1.12''': Markers placed in editor will be in the array as a string of their name. Markers placed by the player will begin with "_USER_DEFINED #."
 +
 +
<dd class="notedate">Posted on March 17, 2014
 +
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]
 +
<dd class="note">To expand on the comment above. In Multiplayer, user created marker will appear in [[allMapMarkers]] as _USER_DEFINED #ID/Number, where ID is unique id related to _id param from [[onPlayerConnected]] and Number is sequential integer incremented by 1 with each marker placement by the IDed user.
 +
<BR><BR>
  
 
<!-- Note Section END -->
 
<!-- Note Section END -->

Latest revision as of 12:02, 14 November 2019

Introduced with Arma 3 version 0.500.50
Hover & click on the images for descriptions

Description

Description:
Returns all markers in map including user placed markers (_USER_DEFINED #).

Since Arma 3 v1.57.134377 User defined markers have the following name format:
_USER_DEFINED #<PlayerID>/<MarkerID>/<ChannelID> where: For custom waypoint position (LShift+LMB) see customWaypointPosition

Syntax

Syntax:
allMapMarkers
Return Value:
Array of Strings

Examples

Example 1:
_markers = allMapMarkers; returns: ["marker1","_USER_DEFINED #2/0"]
Example 2:
{ private "_a"; _a = toArray _x; _a resize 15; if (toString _a == "_USER_DEFINED #") then { deleteMarker _x; } } forEach allMapMarkers;
Example 3:
if (_someString in allMapMarkers) then { hint (_someString + " is a valid marker name"); };

Additional Information

See also:
createMarkerdeleteMarkercustomWaypointPosition

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Notes

Posted on March 17, 2014
Waffle SS.
A3 1.12: Markers placed in editor will be in the array as a string of their name. Markers placed by the player will begin with "_USER_DEFINED #."
Posted on March 17, 2014
Killzone_Kid
To expand on the comment above. In Multiplayer, user created marker will appear in allMapMarkers as _USER_DEFINED #ID/Number, where ID is unique id related to _id param from onPlayerConnected and Number is sequential integer incremented by 1 with each marker placement by the IDed user.

Bottom Section