BIS fnc moduleDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1= Modules |GROUP1=
|gr1= Modules |GROUP1=
____________________________________________________________________________________________


| Damage given vehicles.
| Damage given vehicles.
{{Informative|Regarding locality: if a hitpoint is defined,<br>{{EffArg|cmd|arg|loc}} [[setHitPointDamage]] is used. Else,<br>
{{Informative|Regarding locality: if a hitpoint is defined,<br>{{EffArg|cmd|arg|loc}} [[setHitPointDamage]] is used. Else,<br>
{{EffArg|cmd|arg|glob}} [[setDamage]] is used.}} |Description=
{{EffArg|cmd|arg|glob}} [[setDamage]] is used.}} |Description=
____________________________________________________________________________________________


| [logic, vehicles, isActivated] call [[BIS_fnc_moduleDamage]] |Syntax=
| [logic, vehicles, isActivated] call [[BIS_fnc_moduleDamage]] |Syntax=
Line 25: Line 22:


| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]] |Return value=
| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]] |Return value=
____________________________________________________________________________________________


|x1= <code>[myLogic, [[vehicle]] [[player]], [[true]]] [[call]] [[BIS_fnc_moduleDamage]];</code> |Example 1=
|x1= <code>[myLogic, [[vehicle]] [[player]], [[true]]] [[call]] [[BIS_fnc_moduleDamage]];</code> |Example 1=
____________________________________________________________________________________________


| [[setDamage]], [[setHitPointDamage]] |See also=
| [[setDamage]], [[setHitPointDamage]] |See also=

Revision as of 23:20, 16 January 2021

Hover & click on the images for description

Description

Description:
Damage given vehicles.
Regarding locality: if a hitpoint is defined,
Template:EffArg setHitPointDamage is used. Else,
Template:EffArg setDamage is used.
Execution:
call
Groups:
Modules

Syntax

Syntax:
[logic, vehicles, isActivated] call BIS_fnc_moduleDamage
Parameters:
logic: Object - the logic. Possible setVariable parameter:
  • "value": Number - (Optional, default 0) wanted damage, in range 0..1
  • "bodypart": String - (Optional, default "0") setHitPointDamage hitpoint name
vehicles: Array of Objects - list of vehicles
isActivated: Boolean - (Optional, default true) if true, the fuel is set
Return Value:
Boolean - true when done, even if isActivated equals false

Examples

Example 1:
[myLogic, vehicle player, true] call BIS_fnc_moduleDamage;

Additional Information

See also:
setDamagesetHitPointDamage

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

Notes

Bottom Section