BIS fnc neutralizeUnit: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Object Manipulation
____________________________________________________________________________________________


| Neutralize an object by intrinsic means:
|descr= Neutralize an object by intrinsic means:
* soldiers are blown up by mine
* soldiers are blown up by mine
*  vehicles are shelled by artillery
*  vehicles are shelled by artillery
Line 13: Line 12:
*  underwater units are simply killed.
*  underwater units are simply killed.


{{Informative|[[allowDamage]] will '''not''' prevent the unit getting killed.}} |DESCRIPTION=
{{Feature|informative|[[allowDamage]] will '''not''' prevent the unit getting killed.}}
____________________________________________________________________________________________


| object call [[BIS_fnc_neutralizeUnit]] |SYNTAX=
|s1= object call [[BIS_fnc_neutralizeUnit]]


|p1= object: [[Object]] |PARAMETER1=
|p1= object: [[Object]]


| [[Boolean]] |RETURNVALUE=
|r1= [[Boolean]]
____________________________________________________________________________________________


|x1= <code>[[cursorTarget]] [[call]] [[BIS_fnc_neutralizeUnit]];</code> |EXAMPLE1=
|x1= <sqf>cursorTarget call BIS_fnc_neutralizeUnit;</sqf>
____________________________________________________________________________________________


| [[setDamage]], [[allowDamage]] |SEEALSO=
|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

Arma 3 logo black.png1.00
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_neutralizeUnit&oldid=352080"