BIS fnc moduleDamage: Difference between revisions

Latest revision as of 00:25, 2 February 2024

1.00

Hover & click on the images for description

Description

Description:: Damage given vehicles.
ⓘ
Regarding locality: if a hitpoint is defined,
LALocal setHitPointDamage is used. Else,
GAGlobal 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:: setDamage setHitPointDamage

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.00
-|1.00|Game version=
+|gr1= Modules
-|gr1= Modules |GROUP1=
+|descr= Damage given vehicles.
+{{Feature|informative|Regarding locality: if a hitpoint is defined,<br>{{Icon|localArgument|32}} [[setHitPointDamage]] is used. Else,<br>
+{{Icon|globalArgument|32}} [[setDamage]] is used.}}
-| Damage given vehicles.
+|s1= [logic, vehicles, isActivated] call [[BIS_fnc_moduleDamage]]
-{{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=
-| [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=
+* "bodypart": [[String]] - (Optional, default "0") [[setHitPointDamage]] hitpoint name
-|p2= vehicles: [[Array]] of [[Object|Objects]] - list of vehicles |Parameter 2=
+|p2= vehicles: [[Array]] of [[Object]]s - list of vehicles
-|p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the fuel is set |Parameter 3=
+|p3= isActivated: [[Boolean]] - (Optional, default [[true]]) if [[true]], the fuel is set
-| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]] |Return value=
+|r1= [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]]
-|x1= <code>[myLogic, [[vehicle]] [[player]], [[true]]] [[call]] [[BIS_fnc_moduleDamage]];</code> |Example 1=
+|x1= <sqf>[myLogic, vehicle player, true] call BIS_fnc_moduleDamage;</sqf>
-| [[setDamage]], [[setHitPointDamage]] |See also=
+|seealso= [[setDamage]] [[setHitPointDamage]]
 }}
-<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:Functions|{{uc:moduleDamage}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:moduleDamage}}]]