BIS fnc markerToTrigger: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - " |s1=[" to " |s1= [")
 
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Map and Markers


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


| <pre>/*
|s1= [markerName, trigger'', localChange''] call [[BIS_fnc_markerToTrigger]]
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
____________________________________________________________________________________________


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


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


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


|x1= <code></code> |=
|x1= <sqf>private _createdMarker = ["marker1", myTrigger] call BIS_fnc_markerToTrigger;</sqf>
____________________________________________________________________________________________
 
| |= See also


|seealso= [[createMarker]] [[createMarkerLocal]] [[BIS_fnc_triggerToMarker]]
}}
}}
<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:markerToTrigger}}]]
[[Category:Functions|{{uc:markerToTrigger}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:markerToTrigger}}]]

Latest revision as of 23:11, 12 July 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

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

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:
private _createdMarker = ["marker1", myTrigger] call BIS_fnc_markerToTrigger;

Additional Information

See also:
createMarker createMarkerLocal BIS_fnc_triggerToMarker

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_markerToTrigger&oldid=327202"