BIS fnc moduleDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(Page filling)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| ''N/A'' |= Description
| Damage given vehicles.
{{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=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_moduleDamage]]; --> |= Syntax
| [logic, vehicles, isActivated] call [[BIS_fnc_moduleDamage]] |Syntax=
 
|p1= 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 |Parameter 1=
 
|p2= vehicles: [[Array]] of [[Object|Objects]] - list of vehicles |Parameter 2=


|p1= |= Parameter 1
|p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the fuel is set |Parameter 3=


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


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


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


Line 33: Line 39:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:moduleDamage}}]]
[[Category:Function Group: ObjectModifiers|{{uc:moduleDamage}}]]
[[Category:Function Group: ObjectModifiers|{{uc:moduleDamage}}]]
[[Category:Functions|{{uc:moduleDamage}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:moduleDamage}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:moduleDamage}}]]

Revision as of 11:32, 10 July 2018

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:
Uncategorised

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