allMapMarkers: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Some wiki formatting)
 
(47 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|gr1= Markers


|gr1 = Markers |GROUP1=
|descr= Returns all map marker names, including user-placed markers.


{{Feature|informative|
* {{GVI|arma3|1.58|size= 0.75}} User-defined markers have the following name format: {{hl|_USER_DEFINED #<PlayerID>/<MarkerID>/<ChannelID>}}, where:
** <PlayerID> - unique network id of the player in [[String]] format, also available as [[String]] in the 6th param in [[Arma 3: Mission Event Handlers#PlayerConnected | "PlayerConnected"]] and [[Arma 3: Mission Event Handlers#PlayerDisconnected|"PlayerDisconnected"]] Event Handlers
** <MarkerID> - an incrementing marker counter id
** <ChannelID> - id of the chat channel in which the marker was placed (see [[currentChannel]])
* To obtain the custom waypoint's (set with {{Controls|LShift|LMB}}) position, see [[customWaypointPosition]].
}}


____________________________________________________________________________________________
|s1= [[allMapMarkers]]


| Returns all markers in map including user placed markers (_USER_DEFINED #). <br><br>
|r1= [[Array]] of [[String]]s
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=
|x1= <sqf>_markers = allMapMarkers; // returns e.g ["marker1", "_USER_DEFINED #2/0"]</sqf>


| [[Array]] of [[String]]s|RETURNVALUE=  
|x2= <sqf>
{
private "_a";
_a = toArray _x;
_a resize 15;
if (toString _a == "_USER_DEFINED #") then
// or if (_x select [0, 15] == "_USER_DEFINED #") since {{arma3}} v1.28
{
deleteMarker _x;
};
} forEach allMapMarkers;
</sqf>


|x1= <code>_markers = [[allMapMarkers]];</code>
|x3= <sqf>
 
if (_someString in allMapMarkers) then
returns: ["marker1","_USER_DEFINED #2/0"]|EXAMPLE1=
{
 
hint (_someString + " is an existing marker");
|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=
</sqf>
____________________________________________________________________________________________
 
| [[createMarker]], [[deleteMarker]], [[customWaypointPosition]] |SEEALSO=


| |MPBEHAVIOUR=  
|seealso= [[createMarker]] [[deleteMarker]] [[customWaypointPosition]]
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- 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 -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:05, 17 February 2024

Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns all map marker names, including user-placed markers.
ⓘ
  • Arma 3 logo black.png1.58 User-defined markers have the following name format: _USER_DEFINED #<PlayerID>/<MarkerID>/<ChannelID>, where:
  • To obtain the custom waypoint's (set with ⇧ Shift + Left Mouse Button) position, see customWaypointPosition.
Groups:
Markers

Syntax

Syntax:
allMapMarkers
Return Value:
Array of Strings

Examples

Example 1:
_markers = allMapMarkers; // returns e.g ["marker1", "_USER_DEFINED #2/0"]
Example 2:
{ private "_a"; _a = toArray _x; _a resize 15; if (toString _a == "_USER_DEFINED #") then // or if (_x select [0, 15] == "_USER_DEFINED #") since Arma 3 v1.28 { deleteMarker _x; }; } forEach allMapMarkers;
Example 3:
if (_someString in allMapMarkers) then { hint (_someString + " is an existing marker"); };

Additional Information

See also:
createMarker deleteMarker customWaypointPosition

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
Retrieved from "https://community.bistudio.com/wiki?title=allMapMarkers&oldid=352645"