BIS fnc wpDemine: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(Page filling - missing seeAlso)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.76|= Game version
|1.76|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
| Scripted "CLEAR MINES" [[Waypoint_types|Advanced Waypoint]].
The script needs a unit with the abiility to demine (engineer or explosive specialist [[getUnitTrait|trait]] '''and''' a toolkit). |Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_wpDemine]]; --> |= Syntax
| [group, position, target, clearUnknownMines] call [[BIS_fnc_wpDemine]] |Syntax=
 
_group = _this param [0,grpnull,[grpnull]];
_pos = _this param [1,[],[[]],3];
_target = _this param [2,objnull,[objnull]];
_clearUnknown = _this param [3,true,[true]];
 
|p1= group: [[Group]] - a group with a mine expert |Parameter 1=
 
|p2= position: [[Position]] - the demining centre. Demining radius is defined by [[waypointCompletionRadius]], and defaults to 50 if set to 0 |Parameter 2=
 
|p3= target: [[Anything]] - (Optional, default [[objNull]]) unused parameter |Parameter 3=


|p1= |= Parameter 1
|p4= clearUnknownMines: [[Boolean]] - (Optional, default [[true]]) should the group demine all mines or only the one [[detectedMines|its side knows about]] |Parameter 4=


| |= Return value
| [[Nothing]] |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code><nowiki>[</nowiki>[[group]] [[player]], [[getMarkerPos]] "mineField", [[objNull]], [[false]]] [[call]] [[BIS_fnc_wpDemine]];</code> |Example 1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| |See also=
 
}}
}}


Line 33: Line 43:


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

Revision as of 12:59, 5 June 2018

Hover & click on the images for description

Description

Description:
Scripted "CLEAR MINES" Advanced Waypoint. The script needs a unit with the abiility to demine (engineer or explosive specialist trait and a toolkit).
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[group, position, target, clearUnknownMines] call BIS_fnc_wpDemine
Parameters:
group: Group - a group with a mine expert
position: Position - the demining centre. Demining radius is defined by waypointCompletionRadius, and defaults to 50 if set to 0
target: Anything - (Optional, default objNull) unused parameter
clearUnknownMines: Boolean - (Optional, default true) should the group demine all mines or only the one its side knows about
Return Value:
Nothing

Examples

Example 1:
[group player, getMarkerPos "mineField", objNull, false] call BIS_fnc_wpDemine;

Additional Information

See also:
See also needed

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