setHitIndex: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (2.16 -> 2.18)
 
(43 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command


{{Command|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.50


| arma3 |= Game name
|arg= local


|1.50|= Game version
|eff= global


|arg= local |Multiplayer Arguments=
|gr1= Object Manipulation


|eff= global |Multiplayer Effects=
|descr= Sets the current level of damage for a specific Hit Point. 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.
|s1= vehicle [[setHitIndex]] [hitPartIndex, damage, useEffects, killer, instigator, breakRotor]
 
|p1= vehicle : [[Object]] - vehicle to be damaged
 
|p2= hitPartIndex: [[Number]] - hit part index of the Hit Point
 
|p3= damage: [[Number]] - level of damage
* 0: no damage
* 0: no damage
* 1: full damage |DESCRIPTION=
* 1: full damage
____________________________________________________________________________________________
 
|p4= useEffects: [[Boolean]] - (Optional, default [[true]]) [[false]] to skip destruction effects
|p4since= arma3 1.68


| vehicle '''setHitIndex''' [hitPartIndex, damage, useEffects]|SYNTAX=
|p5= killer: [[Object]] - (Optional, default [[objNull]]) the entity that caused the damage. If the damage leads to the death of the unit, the killer will be used as the object that caused the kill. <br>
* It can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled). <br>
* It will alter the killer's [[rating]] as if the killer directly killed the unit. <br>
* It will be listed as <sqf inline>_killer</sqf> parameter in the [[Arma_3:_Event_Handlers#Killed|Killed]] event handler.
|p5since= arma3 2.08


|p1= vehicle : [[Object]] - vehicle to be damaged |PARAMETER1=
|p6= instigator: [[Object]] - (Optional, default [[objNull]]) the person that instigated the damage.
|p2=[hitPartIndex, damage]: - [[Array]] |PARAMETER2=
* if a tank is a killer, the tank gunner that pulled the trigger is instigator
|p3= hitPartIndex: [[Number]] - hit part index of the Hit Point|PARAMETER3=
* it will be listed as <sqf inline>_instigator</sqf> parameter in the [[Arma 3: Event Handlers#Killed|Killed]] event handler.
|p4= damage: [[Number]] - level of damage |PARAMETER4=
|p6since= arma3 2.12
|p5 = useEffects (Optional): [[Boolean]] - [[false]] to skip destruction effects. Default: [[true]] (Since Arma 3 v1.67)|=


| [[Nothing]] |RETURNVALUE=
|p7= breakRotor: [[Boolean]] - (Optional, default [[false]]) if the hitpoint is rotor on a helicopter, [[true]] will break the rotor as well as play corresponding sound if 'useEffects' is also [[true]].
____________________________________________________________________________________________
|p7since= arma3 2.18


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


|x2= <code>[[player]] [[setHitIndex]] [7, 0.5];</code> |=
|x1= <sqf>vehicle player setHitIndex [1, 1];</sqf>


| [[getAllHitPointsDamage]], [[getHitIndex]], [[getHitPointDamage]], [[setHitPointDamage]], [[setHit]], [[getHit]], [[setDamage]], [[damage]] |SEEALSO=
|x2= <sqf>player setHitIndex [7, 0.5];</sqf>


|seealso= [[getAllHitPointsDamage]] [[getHitIndex]] [[getHitPointDamage]] [[setHitPointDamage]] [[setHit]] [[getHit]] [[setDamage]] [[damage]] [[forceHitPointsDamageSync]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:09, 8 February 2024

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, killer, instigator, breakRotor]
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
since Arma 3 logo black.png1.68
useEffects: Boolean - (Optional, default true) false to skip destruction effects
since Arma 3 logo black.png2.08
killer: Object - (Optional, default objNull) the entity that caused the damage. If the damage leads to the death of the unit, the killer will be used as the object that caused the kill.
  • It can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled).
  • It will alter the killer's rating as if the killer directly killed the unit.
  • It will be listed as _killer parameter in the Killed event handler.
since Arma 3 logo black.png2.12
instigator: Object - (Optional, default objNull) the person that instigated the damage.
  • if a tank is a killer, the tank gunner that pulled the trigger is instigator
  • it will be listed as _instigator parameter in the Killed event handler.
since Arma 3 logo black.png2.18
breakRotor: Boolean - (Optional, default false) if the hitpoint is rotor on a helicopter, true will break the rotor as well as play corresponding sound if 'useEffects' is also true.
Return Value:
Nothing

Examples

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

Additional Information

See also:
getAllHitPointsDamage getHitIndex getHitPointDamage setHitPointDamage setHit getHit setDamage damage forceHitPointsDamageSync

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