setHitIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <dl class="command_description"> </dl>" to "")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3


|1.50
|game2= 1.50


|arg= local
|arg= local
Line 11: Line 11:
|gr1= Object Manipulation
|gr1= Object Manipulation


| 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.
|descr= Sets the current level of damage for a specific Hit Point. All hit points can be obtained with [[getAllHitPointsDamage]] command.
* 0: no damage
* 1: full damage


| vehicle '''setHitIndex''' [hitPartIndex, damage, useEffects]
|s1= vehicle '''setHitIndex''' [hitPartIndex, damage, useEffects]


|p1= vehicle : [[Object]] - vehicle to be damaged
|p1= vehicle : [[Object]] - Vehicle to be damaged


|p2= hitPartIndex: [[Number]] - hit part index of the Hit Point
|p2= hitPartIndex: [[Number]] - Hit part index of the Hit Point


|p3= damage: [[Number]] - level of damage
|p3= damage: [[Number]] - Level of damage
* 0: no damage
* 1: full damage


|p4 = useEffects: [[Boolean]] - (Optional, default [[true]]) [[false]] to skip destruction effects. {{Since|arma3|1.67|y}}
|p4 = useEffects: [[Boolean]] - (Optional, default [[true]]) [[false|False]] to skip destruction effects. {{Since|arma3|1.68|y}}


| [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[[vehicle]] [[player]] [[setHitIndex]] [1, 1];</code>
|x1= <code>[[vehicle]] [[player]] [[setHitIndex]] [1, 1];</code>

Revision as of 10:06, 16 April 2021

Arma 3 logo black.png?-wrong parameter ("1.50") defined!-[[:Category:Introduced with 1.50 version |?]]
Hover & click on the images for description

Description

Description:
Sets the current level of damage for a specific Hit Point. All hit points can be obtained with getAllHitPointsDamage command.
Groups:
Object Manipulation

Syntax

Syntax:
vehicle setHitIndex [hitPartIndex, damage, useEffects]
Parameters:
vehicle : Object - Vehicle to be damaged
hitPartIndex: Number - Hit part index of the Hit Point
damage: Number - Level of damage
  • 0: no damage
  • 1: full damage
useEffects: Boolean - (Optional, default true) False to skip destruction effects. Template:Since
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

[[ Category: 1.50: Scripting Commands | SETHITINDEX]]