BIS fnc markerPath: Difference between revisions

Latest revision as of 17:00, 13 July 2022

1.00

0.50

GEGlobal

Hover & click on the images for description

Description

Description:: Create marker(s) between two points.
Execution:: call
Groups:: Map and Markers

Syntax

Syntax:

[start, end, spacing, params] call BIS_fnc_markerPath

Parameters:

start: Position, Waypoint, Object, Location or String:

Position - position [x,y] or [x,y,z]
Waypoint - format [group, index]
Object - object's position
Location - location's position
String - marker name

end: same as start

spacing: Number - (Optional, default 1000) distance between markers. When value is negative, line marker is used instead with thickness of this value

params: Array - (Optional, default ["BIS_fnc_markerPath_marker_#", "mil_triangle", "colorgreen"]) marker params (see BIS_fnc_markerCreate for details)

Return Value:

Array - list of created markers

Examples

Example 1:: ["markerStart", "markerEnd"] call BIS_fnc_markerPath;
Example 2:: [player, nearestLocation [getPos player, "nameCity"]] call BIS_fnc_markerPath;

Additional Information

See also:: createMarker BIS_fnc_markWaypoints

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= tkoh
-____________________________________________________________________________________________
+|version1= 1.00
-| tkoh |= Game name
+|game2= arma3
+|version2= 0.50
-|1.00|= Game version
+|gr1= Map and Markers
-____________________________________________________________________________________________
-| <pre>/*
+|eff= global
-	Description:
+|descr= Create marker(s) between two points.
-	Creater marker(s) between two points
-	Parameter(s):
+|s1= [start, end, spacing, params] call [[BIS_fnc_markerPath]]
-	_this select 0: start (value type see _this select 1)
-	_this select 1: end
-		ARRAY - position [x,y] or [x,y,z] or waypoint position [GROUP,NUMBER]
-		OBJECT - object's position
-		LOCATION - location's position
-		STRING - marker's position
-	_this select 2 (Optional): NUMBER - distance between markers.
-		When value is negative, line marker is used instead with thickness of this value
-	_this select 3 (Optional): ARRAY - marker params (see BIS_fnc_markerCreate for details)
-	Returns:
+|p1= start: [[Position]], [[Waypoint]], [[Object]], [[Location]] or [[String]]:
-	ARRAY - list of created markers
+* [[Position]] - position [x,y] or [x,y,z]
-*/
+* [[Waypoint]] - format [group, index]
+* [[Object]] - object's position
+* [[Location]] - location's position
+* [[String]] - marker name
-//--- Marker settings
+|p2= end: same as ''start''
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_markerPath]]; --> |= Syntax
+|p3= spacing: [[Number]] - (Optional, default 1000) distance between markers. When value is negative, line marker is used instead with thickness of this value
-|p1= |= Parameter 1
+|p4= params: [[Array]] - (Optional, default ["BIS_fnc_markerPath_marker_''#''", "mil_triangle", "colorgreen"]) marker params (see [[BIS_fnc_markerCreate]] for details)
-| |= Return value
+|r1= [[Array]] - list of created markers
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|x1= <sqf>["markerStart", "markerEnd"] call BIS_fnc_markerPath;</sqf>
-____________________________________________________________________________________________
-| |= See also
+|x2= <sqf>[player, nearestLocation [getPos player, "nameCity"]] call BIS_fnc_markerPath;</sqf>
+|seealso= [[createMarker]] [[BIS_fnc_markWaypoints]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Map|{{uc:markerPath}}]]
-[[Category:Functions|{{uc:markerPath}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:markerPath}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:markerPath}}]]