BIS fnc wpDemine: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Waypoints


|1.00|= Game version
|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).


| <pre>#define DEBUG
|s1= [group, position, target, clearUnknownMines] call [[BIS_fnc_wpDemine]]
#define VAR_MINE "BIS_fnc_wpDemine_mine"
#define VAR_COUNTER "BIS_fnc_wpDemine_counter"
#define TIMEOUT_COUNTER 10
#define DELAY 1


#ifdef DEBUG
|p1= group: [[Group]] - a group with a mine expert
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_wpDemine]]; --> |= Syntax
|p2= position: [[Position]] - the demining centre. Demining radius is defined by [[waypointCompletionRadius]], and defaults to 50 if set to 0


|p1= |= Parameter 1
|p3= target: [[Anything]] - (Optional, default [[objNull]]) unused parameter


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


|x1= <code></code> |=
|r1= [[Nothing]]
____________________________________________________________________________________________


| |= See also
|x1= <sqf>[group player, getMarkerPos "mineField", objNull, false] call BIS_fnc_wpDemine;</sqf>


|seealso= [[Waypoints]] [[:Category:Command_Group:_Waypoints|Waypoints Command Group]]
}}
}}
<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: Waypoints|{{uc:wpDemine}}]]
[[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"