BIS fnc markerPath: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| tkoh |= Game name
| tkoh |Game name=
 
|1.00|Game version=


|1.00|= Game version
|eff= global |Effect in MP=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Creater marker(s) between two points. |Description=
____________________________________________________________________________________________


Description:
| [start, end, spacing, params] call [[BIS_fnc_markerPath]] |Syntax=
Creater marker(s) between two points


Parameter(s):
|p1= start: [[Position]], [[Waypoint]], [[Object]], [[Location]] or [[String]]:
_this select 0: start (value type see _this select 1)
* [[Position]] - position [x,y] or [x,y,z]
_this select 1: end
* [[Waypoint]] - format [group, index]
ARRAY - position [x,y] or [x,y,z] or waypoint position [GROUP,NUMBER]
* [[Object]] - object's position
OBJECT - object's position
* [[Location]] - location's position
LOCATION - location's position
* [[String]] - marker name |Parameter 1=
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:
|p2= end: same as ''start'' |Parameter 2=
ARRAY - list of created markers
*/


//--- Marker settings
|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=
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_markerPath]]; --> |= Syntax
|p4= params: [[Array]] - (Optional, default ["BIS_fnc_markerPath_marker_''#''", "mil_triangle", "colorgreen"]) marker params (see [[BIS_fnc_markerCreate]] for details) |Parameter4=


|p1= |= Parameter 1
| [[Array]] - list of created markers |= Return value
____________________________________________________________________________________________


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


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


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


Revision as of 13:40, 29 May 2018

tkoh logo small.png1.00
GEGlobal
Hover & click on the images for description

Description

Description:
Creater marker(s) between two points.
Execution:
call
Groups:
Uncategorised

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

Notes

Bottom Section

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