BIS fnc markerToTrigger: Difference between revisions

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


{{Function|= Comments
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| Makes an existing or new marker cover a trigger area. |Description=
 
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| [markerName, trigger'', localChange''] call [[BIS_fnc_markerToTrigger]] |Syntax=
File: markerToTrigger.sqf
Description:
Makes an existing or new marker cover a trigger area.
Parameter(s):
_this select 0: <string> marker name - if no marker uses the name, a marker will be created
_this select 1: <object> trigger that will be covered by the marker
_this select 2 (Optional): <boolean> changes are local (default: false)
Returns:
Marker name (string). Returns empty string if a marker couldn't be moved or created.
How to use:
_marker = ["marker1", trigger1] call BIS_fnc_markerToTrigger;
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p1= markerName: [[String]] - marker name - if no marker uses the name, a marker will be created |Parameter 1=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_markerToTrigger]]; --> |= Syntax
|p2= trigger: [[Object]] - trigger that will be covered by the marker |Parameter 2=


|p1= |= Parameter 1
|p3= localChange: [[Boolean]] (Optional, default [[false]]) are changes local (local marker creation and/or local marker changes) |Parameter 3=


| |= Return value
| [[String]] - marker name or "" if marker couldn't be moved or created or if provided ''markerName'' is "" |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>_createdMarker = ["marker1", myTrigger] [[call]] [[BIS_fnc_markerToTrigger]];</code> |Example 1=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


Line 51: Line 35:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:markerToTrigger}}]]
[[Category:Function Group: Map|{{uc:markerToTrigger}}]]
[[Category:Function Group: Map|{{uc:markerToTrigger}}]]
[[Category:Functions|{{uc:markerToTrigger}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:markerToTrigger}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:markerToTrigger}}]]

Revision as of 15:37, 6 June 2018

Hover & click on the images for description

Description

Description:
Makes an existing or new marker cover a trigger area.
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[markerName, trigger, localChange] call BIS_fnc_markerToTrigger
Parameters:
markerName: String - marker name - if no marker uses the name, a marker will be created
trigger: Object - trigger that will be covered by the marker
localChange: Boolean (Optional, default false) are changes local (local marker creation and/or local marker changes)
Return Value:
String - marker name or "" if marker couldn't be moved or created or if provided markerName is ""

Examples

Example 1:
_createdMarker = ["marker1", myTrigger] call BIS_fnc_markerToTrigger;

Additional Information

See also:
createMarkercreateMarkerLocal

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