BIS fnc wpDemine: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects? in MP|Multiplayer Effects(...)
Line 1: Line 1:
{{Function|Comments=
{{Function| arma3|1.76|gr1= Waypoints| Scripted "CLEAR MINES" [[Waypoints|Advanced Waypoint]].
 
The script needs a unit with the abiility to demine (engineer or explosive specialist [[getUnitTrait|trait]] '''and''' a toolkit).| [group, position, target, clearUnknownMines] call [[BIS_fnc_wpDemine]]_group = _this param [0,grpnull,[grpnull]];
| arma3 |Game name=
 
|1.76|Game version=
 
|gr1= Waypoints |GROUP1=
 
| Scripted "CLEAR MINES" [[Waypoints|Advanced Waypoint]].
The script needs a unit with the abiility to demine (engineer or explosive specialist [[getUnitTrait|trait]] '''and''' a toolkit). |Description=
 
| [group, position, target, clearUnknownMines] call [[BIS_fnc_wpDemine]] |Syntax=
 
_group = _this param [0,grpnull,[grpnull]];
_pos = _this param [1,[],[[]],3];
_pos = _this param [1,[],[[]],3];
_target = _this param [2,objnull,[objnull]];
_target = _this param [2,objnull,[objnull]];
_clearUnknown = _this param [3,true,[true]];
_clearUnknown = _this param [3,true,[true]];


|p1= group: [[Group]] - a group with a mine expert |Parameter 1=
|p1= group: [[Group]] - a group with a mine expert|p2= position: [[Position]] - the demining centre. Demining radius is defined by [[waypointCompletionRadius]], and defaults to 50 if set to 0|p3= target: [[Anything]] - (Optional, default [[objNull]]) unused parameter|p4= clearUnknownMines: [[Boolean]] - (Optional, default [[true]]) should the group demine all mines or only the one [[detectedMines|its side knows about]]| [[Nothing]]|x1= <code><nowiki>[</nowiki>[[group]] [[player]], [[getMarkerPos]] "mineField", [[objNull]], [[false]]] [[call]] [[BIS_fnc_wpDemine]];</code>| [[Waypoints]], [[:Category:Command_Group:_Waypoints|Waypoints Command Group]] |See also=
 
|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=
 
|p4= clearUnknownMines: [[Boolean]] - (Optional, default [[true]]) should the group demine all mines or only the one [[detectedMines|its side knows about]] |Parameter 4=
 
| [[Nothing]] |Return value=
 
|x1= <code><nowiki>[</nowiki>[[group]] [[player]], [[getMarkerPos]] "mineField", [[objNull]], [[false]]] [[call]] [[BIS_fnc_wpDemine]];</code> |Example 1=
 
| [[Waypoints]], [[:Category:Command_Group:_Waypoints|Waypoints Command Group]] |See also=
}}
}}



Revision as of 09:51, 18 January 2021

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

Syntax

Syntax:
Nothing
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:
Waypoints, Waypoints Command Group

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