setHitIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(optional extended params)
m (template:command argument fix)
Line 15: Line 15:
| Set the current level of damage for a specific Hit Point (specified by its hit part index). All hit points can be obtained with [[getAllHitPointsDamage]] command.
| Set the current level of damage for a specific Hit Point (specified by its hit part index). All hit points can be obtained with [[getAllHitPointsDamage]] command.
* 0: no damage
* 0: no damage
* 1: full damage |= Description
* 1: full damage |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| vehicle '''setHitIndex''' [hitPartIndex, damage, useEffects]|= Syntax
| vehicle '''setHitIndex''' [hitPartIndex, damage, useEffects]|SYNTAX=


|p1= vehicle : [[Object]] - vehicle to be damaged |= Parameter 1
|p1= vehicle : [[Object]] - vehicle to be damaged |PARAMETER1=
|p2=[hitPartIndex, damage]: - [[Array]] |= Parameter 2
|p2=[hitPartIndex, damage]: - [[Array]] |PARAMETER2=
|p3= hitPartIndex: [[Number]] - hit part index of the Hit Point|= Parameter 3
|p3= hitPartIndex: [[Number]] - hit part index of the Hit Point|PARAMETER3=
|p4= damage: [[Number]] - level of damage |= Parameter 4
|p4= damage: [[Number]] - level of damage |PARAMETER4=
|p5 = useEffects (Optional): [[Boolean]] - [[false]] to skip destruction effects. Default: [[true]] (Since Arma 3 v1.67)|=
|p5 = useEffects (Optional): [[Boolean]] - [[false]] to skip destruction effects. Default: [[true]] (Since Arma 3 v1.67)|=


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 33: Line 33:
|x2= <code>[[player]] [[setHitIndex]] [7, 0.5];</code> |=
|x2= <code>[[player]] [[setHitIndex]] [7, 0.5];</code> |=


| [[getAllHitPointsDamage]], [[getHitIndex]], [[getHitPointDamage]], [[setHitPointDamage]], [[setHit]], [[getHit]], [[setDamage]], [[damage]] |= See also
| [[getAllHitPointsDamage]], [[getHitIndex]], [[getHitPointDamage]], [[setHitPointDamage]], [[setHit]], [[getHit]], [[setDamage]], [[damage]] |SEEALSO=


}}
}}

Revision as of 14:47, 7 April 2019


Hover & click on the images for description

Description

Description:
Set the current level of damage for a specific Hit Point (specified by its hit part index). All hit points can be obtained with getAllHitPointsDamage command.
  • 0: no damage
  • 1: full damage
Groups:
Uncategorised

Syntax

Syntax:
vehicle setHitIndex [hitPartIndex, damage, useEffects]
Parameters:
vehicle : Object - vehicle to be damaged
[hitPartIndex, damage]: - Array
hitPartIndex: Number - hit part index of the Hit Point
damage: Number - level of damage
useEffects (Optional): Boolean - false to skip destruction effects. Default: true (Since Arma 3 v1.67)
Return Value:
Nothing

Examples

Example 1:
vehicle player setHitIndex [1, 1];
Example 2:
player setHitIndex [7, 0.5];

Additional Information

See also:
getAllHitPointsDamagegetHitIndexgetHitPointDamagesetHitPointDamagesetHitgetHitsetDamagedamage

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