setHitPointDamage: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) (Fix server execution) |
Lou Montana (talk | contribs) m (Text replacement - "{{Link|:Category:" to "{{Link|Category:") |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 13: | Line 13: | ||
|gr1= Object Manipulation | |gr1= Object Manipulation | ||
|descr= 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]]. | |descr= | ||
{{{!}} class="wikitable float-right align-center-col-2" | |||
! {{Link|Category: Event Handlers|Event Handler}} | |||
! Triggered | |||
{{!}}- | |||
{{!}} {{hl|Hit}} | |||
{{!}} {{Icon|unchecked}} | |||
{{!}}- | |||
{{!}} {{hl|HandleDamage}} | |||
{{!}} {{Icon|unchecked}} | |||
{{!}}- | |||
{{!}} {{hl|Killed}} | |||
{{!}} {{Icon|checked}} | |||
{{!}}- | |||
{{!}} {{hl|MPKilled}} | |||
{{!}} {{Icon|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]]. | |||
{{Feature|informative|See also [[BIS_fnc_setHitPointDamage]] for setting hit with dependency.}} | {{Feature|informative|See also [[BIS_fnc_setHitPointDamage]] for setting hit with dependency.}} | ||
|s1= vehicle [[setHitPointDamage]] [hitPointName, damage, useEffects, killer, instigator] | |s1= vehicle [[setHitPointDamage]] [hitPointName, damage, useEffects, killer, instigator, breakRotor] | ||
|p1= vehicle : [[Object]] - vehicle to be damaged | |p1= vehicle: [[Object]] - vehicle to be damaged | ||
|p2= hitPointName: [[String]] - name of the Hit Point class | |p2= hitPointName: [[String]] - name of the Hit Point class | ||
| Line 27: | Line 45: | ||
|p4since= arma3 1.68 | |p4since= arma3 1.68 | ||
|p5= | |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 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 alter the killer's [[rating]] as if the killer directly killed the unit. <br> | ||
| Line 33: | Line 51: | ||
|p5since= arma3 2.08 | |p5since= arma3 2.08 | ||
|p6= | |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 | * 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. | * it will be listed as <sqf inline>_instigator</sqf> parameter in the [[Arma 3: Event Handlers#Killed|Killed]] event handler. | ||
|p6since= arma3 2.12 | |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]] | |r1= [[Nothing]] | ||
| Line 49: | Line 70: | ||
</sqf> | </sqf> | ||
|seealso= [[getHitPointDamage]] [[getAllHitPointsDamage]] [[setHit]] [[getHit]] [[setDamage]] [[damage]] [[getHitIndex]] [[setHitIndex]] [[BIS_fnc_setHitPointDamage]] [[getHitPointDamage#Notes|Common TKOH Hit Points]] | |seealso= [[getHitPointDamage]] [[getAllHitPointsDamage]] [[setHit]] [[getHit]] [[setDamage]] [[damage]] [[getHitIndex]] [[setHitIndex]] [[forceHitPointsDamageSync]] [[BIS_fnc_setHitPointDamage]] [[getHitPointDamage#Notes|Common TKOH Hit Points]] | ||
}} | }} | ||
Latest revision as of 14:52, 16 October 2024
Description
- Description:
-
Event Handler Triggered Hit 
HandleDamage
Killed 
MPKilled
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.
- 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
1.68 - useEffects: Boolean - (Optional, default true) false to skip destruction effects
- since 2.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.
- since 2.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 2.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:
- Example 2:
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
- 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).