BIS fnc neutralizeUnit: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(29 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Object Manipulation


|1.00|= Game version
|descr= Neutralize an object by intrinsic means:
____________________________________________________________________________________________
* soldiers are blown up by mine
*  vehicles are shelled by artillery
*  air units are hit by AA missile
*  underwater units are simply killed.


| <pre>/*
{{Feature|informative|[[allowDamage]] will '''not''' prevent the unit getting killed.}}


Description:
|s1= object call [[BIS_fnc_neutralizeUnit]]
Neutralize an object by intrinsic means
- soldiers are blowed up by mine
- vehicles are shelled by artillery
- air units are hit by AA missile
- underwater units are simply killed


Parameter(s):
|p1= object: [[Object]]
0: OBJECT


Returns:
|r1= [[Boolean]]
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|x1= <sqf>cursorTarget call BIS_fnc_neutralizeUnit;</sqf>
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_neutralizeUnit]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[setDamage]] [[allowDamage]]
}}
}}
<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: Misc|{{uc:neutralizeUnit}}]]
[[Category:Functions|{{uc:neutralizeUnit}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:neutralizeUnit}}]]

Latest revision as of 00:24, 2 February 2024

Hover & click on the images for description

Description

Description:
Neutralize an object by intrinsic means:
  • soldiers are blown up by mine
  • vehicles are shelled by artillery
  • air units are hit by AA missile
  • underwater units are simply killed.
allowDamage will not prevent the unit getting killed.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
object call BIS_fnc_neutralizeUnit
Parameters:
object: Object
Return Value:
Boolean

Examples

Example 1:
cursorTarget call BIS_fnc_neutralizeUnit;

Additional Information

See also:
setDamage allowDamage

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