BIS fnc markerPath: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1 = Map and Markers |GROUP1=")
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| tkoh |Game name=
|game1= tkoh
|version1= 1.00


|1.00|Game version=
|game2= arma3
|version2= 0.50


|gr1 = Map and Markers |GROUP1=
|gr1= Map and Markers


|eff= global |Effect in MP=
|eff= global
____________________________________________________________________________________________


| Create marker(s) between two points. |Description=
|descr= Create marker(s) between two points.
____________________________________________________________________________________________


| [start, end, spacing, params] call [[BIS_fnc_markerPath]] |Syntax=
|s1= [start, end, spacing, params] call [[BIS_fnc_markerPath]]


|p1= start: [[Position]], [[Waypoint]], [[Object]], [[Location]] or [[String]]:
|p1= start: [[Position]], [[Waypoint]], [[Object]], [[Location]] or [[String]]:
Line 21: Line 20:
* [[Object]] - object's position
* [[Object]] - object's position
* [[Location]] - location's position
* [[Location]] - location's position
* [[String]] - marker name |Parameter 1=
* [[String]] - marker name


|p2= end: same as ''start'' |Parameter 2=
|p2= end: same as ''start''


|p3= spacing: [[Number]] - (Optional, default 1000) distance between markers. When value is negative, line marker is used instead with thickness of this value |Parameter 3=
|p3= spacing: [[Number]] - (Optional, default 1000) distance between markers. When value is negative, line marker is used instead with thickness of this value


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


| [[Array]] - list of created markers |Return value=
|r1= [[Array]] - list of created markers
____________________________________________________________________________________________


|x1= <code>["markerStart", "markerEnd"] [[call]] [[BIS_fnc_markerPath]];</code> |Example 1=
|x1= <sqf>["markerStart", "markerEnd"] call BIS_fnc_markerPath;</sqf>


|x2= <code><nowiki>[</nowiki>[[player]], [[nearestLocation]] [<nowiki/>[[getPos]] [[player]], "nameCity"]] [[call]] [[BIS_fnc_markerPath]];</code> |Example 2=
|x2= <sqf>[player, nearestLocation [getPos player, "nameCity"]] call BIS_fnc_markerPath;</sqf>
____________________________________________________________________________________________


| [[createMarker]], [[BIS_fnc_markWaypoints]] |See also=
|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}}]]

Latest revision as of 17:00, 13 July 2022

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