BIS fnc wpDemine: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed link to waypoint types)
m (Some wiki formatting)
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.76


|1.76|Game version=
|gr1= Waypoints


|gr1= Waypoints |GROUP1=
|descr= 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).


| Scripted "CLEAR MINES" [[Waypoints|Advanced Waypoint]].
|s1= [group, position, target, clearUnknownMines] call [[BIS_fnc_wpDemine]]
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=
|p1= group: [[Group]] - a group with a mine expert


_group = _this param [0,grpnull,[grpnull]];
|p2= position: [[Position]] - the demining centre. Demining radius is defined by [[waypointCompletionRadius]], and defaults to 50 if set to 0
_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=
|p3= target: [[Anything]] - (Optional, default [[objNull]]) unused parameter


|p2= position: [[Position]] - the demining centre. Demining radius is defined by [[waypointCompletionRadius]], and defaults to 50 if set to 0 |Parameter 2=
|p4= clearUnknownMines: [[Boolean]] - (Optional, default [[true]]) should the group demine all mines or only the one [[detectedMines|its side knows about]]


|p3= target: [[Anything]] - (Optional, default [[objNull]]) unused parameter |Parameter 3=
|r1= [[Nothing]]


|p4= clearUnknownMines: [[Boolean]] - (Optional, default [[true]]) should the group demine all mines or only the one [[detectedMines|its side knows about]] |Parameter 4=
|x1= <sqf>[group player, getMarkerPos "mineField", objNull, false] call BIS_fnc_wpDemine;</sqf>


| [[Nothing]] |Return value=
|seealso= [[Waypoints]] [[:Category:Command_Group:_Waypoints|Waypoints Command Group]]
____________________________________________________________________________________________
 
|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=
}}
}}
<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:Functions|{{uc:wpDemine}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:wpDemine}}]]

Latest revision as of 12:19, 6 May 2022

Arma 3 logo black.png1.76
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:
[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:
Waypoints Waypoints Command Group

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_wpDemine&oldid=310701"