BIS fnc moduleDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.00
|1.00


|gr1= Modules
|gr1= Modules


| Damage given vehicles.
|descr= Damage given vehicles.
{{Informative|Regarding locality: if a hitpoint is defined,<br>{{EffArg|cmd|arg|loc}} [[setHitPointDamage]] is used. Else,<br>
{{Feature|informative|Regarding locality: if a hitpoint is defined,<br>{{Icon|localArgument|32}} [[setHitPointDamage]] is used. Else,<br>
{{EffArg|cmd|arg|glob}} [[setDamage]] is used.}}
{{Icon|globalArgument|32}} [[setDamage]] is used.}}


| [logic, vehicles, isActivated] call [[BIS_fnc_moduleDamage]]
|s1= [logic, vehicles, isActivated] call [[BIS_fnc_moduleDamage]]


|p1= logic: [[Object]] - the logic. Possible [[setVariable]] parameter:
|p1= logic: [[Object]] - the logic. Possible [[setVariable]] parameter:
Line 17: Line 16:
* "bodypart": [[String]] - (Optional, default "0") [[setHitPointDamage]] hitpoint name
* "bodypart": [[String]] - (Optional, default "0") [[setHitPointDamage]] hitpoint name


|p2= vehicles: [[Array]] of [[Object|Objects]] - list of vehicles
|p2= vehicles: [[Array]] of [[Object]]s - list of vehicles


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


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


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


| [[setDamage]], [[setHitPointDamage]]
|seealso= [[setDamage]] [[setHitPointDamage]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:moduleDamage}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:moduleDamage}}]]

Latest revision as of 00:25, 2 February 2024

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