BIS fnc markerPath: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| tkoh |Game name=
| tkoh


|1.00|Game version=
|1.00


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


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


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


| [start, end, spacing, params] call [[BIS_fnc_markerPath]] |Syntax=
| [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 18: Line 18:
* [[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=
| [[Array]] - list of created markers


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


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


| [[createMarker]], [[BIS_fnc_markWaypoints]] |See also=
| [[createMarker]], [[BIS_fnc_markWaypoints]]
}}
}}



Revision as of 00:10, 18 January 2021

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

Bottom Section