setHitPointDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "{{Link|:Category:" to "{{Link|Category:")
 
(84 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command


{{Command|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| TKOH |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|arg= local


|arg= local |= Arguments in MP
|eff= global


|eff= global |= Effects in MP
|gr1= Object Manipulation
____________________________________________________________________________________________


| Set the current level of damage for a specific Hit Point (specified by its config class).
|descr=
* 0: no damage
{{{!}} class="wikitable float-right align-center-col-2"
* 1: full damage |= Description
! {{Link|Category: Event Handlers|Event Handler}}
____________________________________________________________________________________________
! Triggered
{{!}}-
{{!}} {{hl|Hit}}
{{!}} {{Icon|unchecked}}
{{!}}-
{{!}} {{hl|HandleDamage}}
{{!}} {{Icon|unchecked}}
{{!}}-
{{!}} {{hl|Killed}}
{{!}} {{Icon|checked}}
{{!}}-
{{!}} {{hl|MPKilled}}
{{!}} {{Icon|checked}}
{{!}}}


| vehicle '''setHitPointDamage''' [hitPointName, damage]|= Syntax
Set the current level of damage for a specific Hit Point (specified by its config class). This command has no effect when [[allowDamage]] is set to [[false]].
{{Feature|informative|See also [[BIS_fnc_setHitPointDamage]] for setting hit with dependency.}}


|p1= vehicle : [[Object]] - vehicle to be damaged |= Parameter 1
|s1= vehicle [[setHitPointDamage]] [hitPointName, damage, useEffects, killer, instigator, breakRotor]
|p2= hitPointName: [[String]] - name of the Hit Point class |= Parameter 2
|p3= damage: [[String]] - level of damage |= Parameter 3


| [[Nothing]] |= Return value
|p1= vehicle: [[Object]] - vehicle to be damaged
____________________________________________________________________________________________


|x1= <code>(vehicle player) [[setHitPointDamage]] ["hitEngine2", 1.0];</code> |=
|p2= hitPointName: [[String]] - name of the Hit Point class


|x2= <code>[[player]] [[setHitPointDamage]] ["hitHead", 0.5];
|p3= damage: [[Number]] - level of damage, in range 0..1
[[player]] [[setHitPointDamage]] ["hitBody", 0.5];
[[player]] [[setHitPointDamage]] ["hitHands", 0.5];
[[player]] [[setHitPointDamage]] ["hitLegs", 0.5];</code> |=


| [[getHitPointDamage]], [[setHit]], [[getHit]], [[setDamage]], [[damage]], [[getHitPointDamage#Notes|Common TKOH Hit Points]] |= See also
|p4= useEffects: [[Boolean]] - (Optional, default [[true]]) [[false]] to skip destruction effects
|p4since= arma3 1.68


|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
|p6= 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 <sqf inline>_instigator</sqf> parameter in the [[Arma 3: Event Handlers#Killed|Killed]] event handler.
|p6since= arma3 2.12
|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
|r1= [[Nothing]]
|x1= <sqf>vehicle player setHitPointDamage ["hitEngine2", 1.0];</sqf>
|x2= <sqf>
player setHitPointDamage ["hitHead", 0.5];
player setHitPointDamage ["hitBody", 0.5];
player setHitPointDamage ["hitHands", 0.5];
player setHitPointDamage ["hitLegs", 0.5];
</sqf>
|seealso= [[getHitPointDamage]] [[getAllHitPointsDamage]] [[setHit]] [[getHit]] [[setDamage]] [[damage]] [[getHitIndex]] [[setHitIndex]] [[forceHitPointsDamageSync]] [[BIS_fnc_setHitPointDamage]] [[getHitPointDamage#Notes|Common TKOH Hit Points]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Master85
<!-- Note Section BEGIN -->
|timestamp= 20120830135400
<dd class="notedate">Posted on August 30, 2012 - 13:54
|text= This command is using the Hit Points (defined in the {{hl|HitPoints}} class in the config) while [[setHit]] is using [[Named Selection]]s (defined in the model itself).
<dt class="note">'''[[User:Master85|Master85]]'''<dd class="note">This command is using the Hit Points (defined in the HitPoints class in the config) while [[setHit]] is using [[Named_Selection|Named Selections]] (defined in the model itself).
}}
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Take On Helicopters: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Latest revision as of 14:52, 16 October 2024

tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalGEGlobal
Hover & click on the images for description

Description

Description:
Event Handler Triggered
Hit Unchecked
HandleDamage Unchecked
Killed Checked
MPKilled Checked

Set the current level of damage for a specific Hit Point (specified by its config class). This command has no effect when allowDamage is set to false.

ⓘ
See also BIS_fnc_setHitPointDamage for setting hit with dependency.
Groups:
Object Manipulation

Syntax

Syntax:
vehicle setHitPointDamage [hitPointName, damage, useEffects, killer, instigator, breakRotor]
Parameters:
vehicle: Object - vehicle to be damaged
hitPointName: String - name of the Hit Point class
damage: Number - level of damage, in range 0..1
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 setHitPointDamage ["hitEngine2", 1.0];
Example 2:
player setHitPointDamage ["hitHead", 0.5]; player setHitPointDamage ["hitBody", 0.5]; player setHitPointDamage ["hitHands", 0.5]; player setHitPointDamage ["hitLegs", 0.5];

Additional Information

See also:
getHitPointDamage getAllHitPointsDamage setHit getHit setDamage damage getHitIndex setHitIndex forceHitPointsDamageSync BIS_fnc_setHitPointDamage Common TKOH Hit Points

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
Master85 - c
Posted on Aug 30, 2012 - 13:54 (UTC)
This command is using the Hit Points (defined in the HitPoints class in the config) while setHit is using Named Selections (defined in the model itself).
Retrieved from "https://community.bistudio.com/wiki?title=setHitPointDamage&oldid=369857"