createMarker: Difference between revisions
Jump to navigation
Jump to search
m (Optimisation to Multiplayer optimisation) |
m (removed note 1 & 2 and moved their information into the command description. Also cleaned up the description. Improved examples so they will now show an actually marker when used.) |
||
Line 11: | Line 11: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Creates a new map marker at the given position | | Creates a new map marker at the given position. The marker name has to be unique, if a marker with the given name exists, the command will be ignored. Use [[deleteMarker]] to delete global marker. | ||
{{Important|The marker will be visible once at least [[markerType]] has been defined: | {{Important|The marker will be visible once at least [[markerType]] has been defined: | ||
<div><code>_markerName {{=}} [[createMarker]] ["markername", [[player]]]; | <div><code>_markerName {{=}} [[createMarker]] ["markername", [[player]]]; | ||
Line 20: | Line 20: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[createMarker]] [name, position, | | [[createMarker]] [name, position, channelID, creator] |Syntax= | ||
|p1= [name, position, channel, creator]: [[Array]] |Parameter 1= | |p1= [name, position, channel, creator]: [[Array]] |Parameter 1= | ||
|p2= name: [[String]] |Parameter 2= | |p2= name: [[String]] - Name of the marker. If "_USER_DEFINED" is added as prefix, the marker can be deleted by the player |Parameter 2= | ||
|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)|Parameter 3= | ||
|p4= | |p4= channelID: [[Number]] - (Optional) The marker channel for MP. {{since|arma3|2.01.146752}}|Parameter 4= | ||
|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}}|Parameter 5= | ||
Line 35: | Line 35: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_marker1 = [[createMarker]] ["Marker1", [[position]] [[player]]];</code> |Example 1= | |x1= <code>_marker1 = [[createMarker]] ["Marker1", [[position]] [[player]]]; | ||
|x2= <code>_marker2 = [[createMarker]] ["Marker2", [[player]]]; {{codecomment|// since {{arma3}} v1.50}}</code> |Example 2= | _marker1 [[setMarkerType]] "hd_dot";</code> |Example 1= | ||
|x2= <code>_marker2 = [[createMarker]] ["Marker2", [[player]]]; | |||
_marker2 [[setMarkerType]] "hd_dot"; {{codecomment|// since {{arma3}} v1.50}}</code> |Example 2= | |||
|x3= <code>_marker3 = [[createMarker]] ["_USER_DEFINED_Marker3", [[player]]]; | |||
_marker3 [[setMarkerType]] "hd_dot"; {{codecomment|// This marker can be deleted by the player who created it}}</code> |Example 3= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|mp= [[createMarker]] is global, use [[createMarkerLocal]] if you want to create a [[local]] marker. |multiplayer= | |mp= [[createMarker]] is global which means it will be created for every client and also for [[JIP]], use [[createMarkerLocal]] if you want to create a [[local]] marker. |multiplayer= | ||
| [[allMapMarkers]], [[deleteMarker]], [[createMarkerLocal]], [[allMapMarkers]] | | [[allMapMarkers]], [[deleteMarker]], [[createMarkerLocal]], [[allMapMarkers]] | ||
Line 46: | Line 52: | ||
[[setMarkerText]], [[setMarkerType]], [[setMarkerAlpha]], [[BIS_fnc_markerToString]], [[BIS_fnc_stringToMarker]] |See also= | [[setMarkerText]], [[setMarkerType]], [[setMarkerAlpha]], [[BIS_fnc_markerToString]], [[BIS_fnc_stringToMarker]] |See also= | ||
}} | }} | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> |
Revision as of 13:12, 25 October 2020
Description
- Description:
- Creates a new map marker at the given position. The marker name has to be unique, if a marker with the given name exists, the command will be ignored. Use deleteMarker to delete global marker.
- Multiplayer:
- createMarker is global which means it will be created for every client and also for JIP, use createMarkerLocal if you want to create a local marker.
- Groups:
- Markers
Syntax
- Syntax:
- createMarker [name, position, channelID, creator]
- Parameters:
- [name, position, channel, creator]: Array
- name: String - Name of the marker. If "_USER_DEFINED" is added as prefix, the marker can be deleted by the player
- position: Array or Object - format position: Position2D, PositionAGL or Object (object's PositionWorld is used)
- channelID: Number - (Optional) The marker channel for MP. Template:since
- creator: Object - (Optional) The marker creator for MP. Template:since
- Return Value:
- String
Examples
- Example 1:
_marker1 = createMarker ["Marker1", position player]; _marker1 setMarkerType "hd_dot";
- Example 2:
_marker2 = createMarker ["Marker2", player]; _marker2 setMarkerType "hd_dot"; // since Arma 3 v1.50
- Example 3:
_marker3 = createMarker ["_USER_DEFINED_Marker3", player]; _marker3 setMarkerType "hd_dot"; // This marker can be deleted by the player who created it
Additional Information
- See also:
- allMapMarkersdeleteMarkercreateMarkerLocalallMapMarkers setMarkerBrushsetMarkerColorsetMarkerDir setMarkerPossetMarkerShapesetMarkerSize setMarkerTextsetMarkerTypesetMarkerAlphaBIS_fnc_markerToStringBIS_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
Bottom Section
- Posted on April 11, 2019 - 07:10 (UTC)
- killzone_kid
-
Passing object as argument for position may produce slightly different position than when explicitly obtaining object position via position commands, as in
createMarker ["marker1", _obj]
may slightly differ fromcreateMarker ["marker1", ASLtoAGL getPosASL _obj]
This is because when object passed as position, the raw getPosWorld is usedcreateMarker ["marker1", ASLtoAGL getPosWorld _obj]
will produce identical result in this case, but may not be what is required
- Posted on May 3, 2019 - 15:53 (UTC)
- 7erra
- 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
Categories:
- Scripting Commands
- Introduced with Arma version 1.00
- Arma: New Scripting Commands
- Arma: Scripting Commands
- Command Group: Markers
- Scripting Commands: Global Effect
- Scripting Commands OFP Elite
- Scripting Commands Armed Assault
- Scripting Commands Arma 2
- Scripting Commands Take On Helicopters
- Scripting Commands Arma 3