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 (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
(45 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 markers in map including user placed markers (_USER_DEFINED #). <br><br>
 
Since Arma 3 v1.58 User defined markers have the following name format: <br>{{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"]] EHs  
____________________________________________________________________________________________
 
| 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
* <MarkerID> - a marker counter id
* <ChannelID> - id of the chat channel on which marker was placed (see [[currentChannel]])
* <ChannelID> - id of the chat channel on which marker was placed (see [[currentChannel]])
For custom waypoint position (LShift+LMB) see [[customWaypointPosition]]
For custom waypoint position (LShift+LMB) see [[customWaypointPosition]]
|DESCRIPTION=
____________________________________________________________________________________________
| '''allMapMarkers''' |SYNTAX=


| [[Array]] of [[String]]s|RETURNVALUE=  
|s1= '''allMapMarkers'''


|x1= <code>_markers = [[allMapMarkers]];</code>
|r1= [[Array]] of [[String]]s


returns: ["marker1","_USER_DEFINED #2/0"]|EXAMPLE1=  
|x1= <sqf>_markers = allMapMarkers;</sqf>


|x2= <code>{
returns: ["marker1","_USER_DEFINED #2/0"]
  [[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]] {
|x2= <sqf>{
  [[hint]] (_someString [[valuea_plus_valueb|+]] " is a valid marker name");
private "_a";
};
_a = toArray _x;
</code> |EXAMPLE3=
_a resize 15;
____________________________________________________________________________________________
if (toString _a == "_USER_DEFINED #") then
{
deleteMarker _x;
}
} forEach allMapMarkers;</sqf>


| [[createMarker]], [[deleteMarker]], [[customWaypointPosition]] |SEEALSO=  
|x3= <sqf>if (_someString in allMapMarkers) then
{
hint (_someString + " is a valid marker name");
};</sqf>


| |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
{{Note
<dt class="note">[[User:Waffle SS.|Waffle SS.]]
|user= 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 #."
|timestamp= 20140317221100
|text= '''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
{{Note
<dt class="note">[[User:Killzone_Kid|Killzone_Kid]]
|user= 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.
|timestamp= 20140317231200
<BR><BR>
|text= 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.
 
}}
<!-- 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}}}}]]

Revision as of 11:21, 13 May 2022

Hover & click on the images for description

Description

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

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

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:
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


Waffle SS. - c
Posted on Mar 17, 2014 - 22:11 (UTC)
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 #."
Killzone_Kid - c
Posted on Mar 17, 2014 - 23:12 (UTC)
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.