BIS fnc moduleDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
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...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= Modules |GROUP1=
|gr1= Modules


| 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.}}


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


|p1= logic: [[Object]] - the logic. Possible [[setVariable]] parameter:
|p1= logic: [[Object]] - the logic. Possible [[setVariable]] parameter:
* "value": [[Number]] - (Optional, default 0) wanted damage, in range 0..1
* "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|Objects]] - 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=
| [[Boolean]] - [[true]] when done, even if ''isActivated'' equals [[false]]


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


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



Revision as of 23:12, 17 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

Bottom Section