createMarkerLocal: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|1.04|Game version=
|1.04


|gr1 = Markers |GROUP1=
|gr1 = Markers


|eff= local |Multiplayer Effects=
|eff= local


| Creates a [[local]] marker at the given position. Marker exists only on PC that created it.  The marker name has to be unique, if a marker with the given name exists, the command will be ignored. Use [[deleteMarkerLocal]] to delete local marker.<br><br>
| Creates a [[local]] marker at the given position. Marker exists only on PC that created it.  The marker name has to be unique, if a marker with the given name exists, the command will be ignored. Use [[deleteMarkerLocal]] to delete local marker.<br><br>
If position is given in 3D format, <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. However [[getMarkerPos]] and [[markerPos]] will always return 0 for <tt>z</tt>.  
If position is given in 3D format, <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. However [[getMarkerPos]] and [[markerPos]] will always return 0 for <tt>z</tt>.  


<br><br>{{Important | Local markers have own set of local commands "xxmarkerxxLocal" to work with. If you use global marker command on a local marker, the local marker will become global marker.}} |DESCRIPTION=
<br><br>{{Important | Local markers have own set of local commands "xxmarkerxxLocal" to work with. If you use global marker command on a local marker, the local marker will become global marker.}}


| [[createMarkerLocal]] [name, position, channel, creator] |Syntax=
| [[createMarkerLocal]] [name, position, channel, creator]


|p1= [name, position, channel, creator]: [[Array]] |Parameter 1=
|p1= [name, position, channel, creator]: [[Array]]


|p2= name: [[String]] |Parameter 2=
|p2= name: [[String]]


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


|p4= channel: [[Number]] - (Optional)The marker side for MP. {{Since|arma3|2.01.146752}}|Parameter 4=
|p4= channel: [[Number]] - (Optional)The marker side for MP. {{Since|arma3|2.01.146752}}


|p5= creator: [[Object]] - (Optional) The marker creator for MP. {{Since|arma3|2.01.146752}}|Parameter 5=
|p5= creator: [[Object]] - (Optional) The marker creator for MP. {{Since|arma3|2.01.146752}}


| [[String]] |RETURNVALUE=
| [[String]]
   
   
|x1= <code>_marker = [[createMarkerLocal]] ["Marker1", [[position]] [[player]]];</code> |EXAMPLE1=
|x1= <code>_marker = [[createMarkerLocal]] ["Marker1", [[position]] [[player]]];</code>
|mp= createMarkerLocal is local, so it should be used along with the other local commands. For global equivalent use [[createMarker]]
|mp= createMarkerLocal is local, so it should be used along with the other local commands. For global equivalent use [[createMarker]]


|[[allMapMarkers]], [[deleteMarkerLocal]], [[createMarker]], [[setMarkerBrushLocal]], [[setMarkerColorLocal]], [[setMarkerDirLocal]], [[setMarkerPosLocal]], [[setMarkerShapeLocal]], [[setMarkerSizeLocal]], [[setMarkerTextLocal]], [[setMarkerTypeLocal]], [[setMarkerAlphaLocal]], [[deleteMarkerLocal]], [[BIS_fnc_markerToString]], [[BIS_fnc_stringToMarkerLocal]]
|[[allMapMarkers]], [[deleteMarkerLocal]], [[createMarker]], [[setMarkerBrushLocal]], [[setMarkerColorLocal]], [[setMarkerDirLocal]], [[setMarkerPosLocal]], [[setMarkerShapeLocal]], [[setMarkerSizeLocal]], [[setMarkerTextLocal]], [[setMarkerTypeLocal]], [[setMarkerAlphaLocal]], [[deleteMarkerLocal]], [[BIS_fnc_markerToString]], [[BIS_fnc_stringToMarkerLocal]]
|SEEALSO=
 


}}
}}

Revision as of 00:10, 18 January 2021

Logo A1 black.png1.04
LELocal
Hover & click on the images for description

Description

Description:
Creates a local marker at the given position. Marker exists only on PC that created it. The marker name has to be unique, if a marker with the given name exists, the command will be ignored. Use deleteMarkerLocal to delete local marker.

If position is given in 3D format, 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. However getMarkerPos and markerPos will always return 0 for z.

⚠
Local markers have own set of local commands "xxmarkerxxLocal" to work with. If you use global marker command on a local marker, the local marker will become global marker.
Multiplayer:
createMarkerLocal is local, so it should be used along with the other local commands. For global equivalent use createMarker
Groups:
Markers

Syntax

Syntax:
createMarkerLocal [name, position, channel, creator]
Parameters:
[name, position, channel, creator]: Array
name: String
position: Array or Object - format position: Position2D, PositionAGL or Object (object's PositionWorld is used)
channel: Number - (Optional)The marker side for MP. Template:Since
creator: Object - (Optional) The marker creator for MP. Template:Since
Return Value:
String

Examples

Example 1:
_marker = createMarkerLocal ["Marker1", position player];

Additional Information

See also:
allMapMarkersdeleteMarkerLocalcreateMarkersetMarkerBrushLocalsetMarkerColorLocalsetMarkerDirLocalsetMarkerPosLocalsetMarkerShapeLocalsetMarkerSizeLocalsetMarkerTextLocalsetMarkerTypeLocalsetMarkerAlphaLocaldeleteMarkerLocalBIS_fnc_markerToStringBIS_fnc_stringToMarkerLocal

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

Unknown
To create a marker which is visible on the map you need to define at least the following three settings: _markerstr = createMarkerLocal ["markername",[_Xpos,_Ypos]]; _markerstr setMarkerShapeLocal "ICON"; _markerstr setMarkerTypeLocal "DOT";

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=createMarkerLocal&oldid=204013"