setHit: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "{{Command " to "{{RV|type=command ") |
Lou Montana (talk | contribs) m (Text replacement - "{{Link|:Category:" to "{{Link|Category:") |
||
(51 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| arma2 | |game1= arma2 | ||
|version1= 1.00 | |||
|1.00 | |game2= arma2oa | ||
|version2= 1.50 | |||
|game3= tkoh | |||
|version3= 1.00 | |||
|game4= arma3 | |||
|version4= 0.50 | |||
|arg= local | |arg= local | ||
Line 11: | Line 19: | ||
|gr1= Object Manipulation | |gr1= Object Manipulation | ||
| Set damage on a part of an object. | |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 damage on a part of an object. | |||
{{Feature|informative|Some part names are in Czech; see the [[ArmA: Armed Assault: Selection Translations|translation table]].}} | |||
|s1= object [[setHit]] [part, damage, useEffects, killer, instigator, breakRotor] | |||
| object [[ | |p1= object: [[Object]] - [[local]] object | ||
| | |p2= part: [[String]] - name of the part ([[Named_Selection|selection]] name) | ||
| | |p3= damage: [[Number]] - damage value ranging 0..1, 0 being fully functional, 1 being destroyed | ||
| | |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. | ||
* 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 <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 setHit ["motor", 1];</sqf> | ||
| | |x2= <sqf>vehicle player setHit ["mala vrtule", 0.95];</sqf> | ||
| [[getHit]] | |x3= <sqf> | ||
if (local _heli) then | |||
{ | |||
_heli setHit ["velka vrtule", 0]; | |||
} | |||
else | |||
{ | |||
hint ("Vehicle " + str _heli + " must be local to this machine to do that!"); | |||
}; | |||
</sqf> | |||
|seealso= [[getHit]] [[getHitPointDamage]] [[setHitPointDamage]] [[damage]] [[setDamage]] [[setFuel]] [[setAmmo]] [[getHitIndex]] [[setHitIndex]] [[forceHitPointsDamageSync]] | |||
}} | }} | ||
{{Note | |||
|user= Deadfast | |||
|timestamp= 20090824110900 | |||
|text= Damaging specific parts of the vehicle will not update its overall [[damage]] value (as of v1.03): | |||
<sqf> | |||
player setHit ["hands", 0.9]; | |||
< | hint str (damage player); // will return 0 | ||
</sqf> | |||
|game= arma2 | |||
}} | |||
{{Note | |||
|user= DenV | |||
|timestamp= 20110329142500 | |||
|text= Direct use of the names of sections of the model is likely a bad practice, and will not work on some addons. | |||
So instead: | So instead: | ||
< | <sqf>_MH60S setHit ["elektronika", _hit];</sqf> | ||
should be used: | should be used: | ||
< | <sqf>_MH60S setHit [getText (configFile >> "cfgVehicles" >> "MH60S" >> "HitPoints" >> "HitAvionics" >> "name"), _hit];</sqf> | ||
}} | |||
Latest revision as of 14:52, 16 October 2024
Description
- Description:
-
Event Handler Triggered Hit HandleDamage Killed MPKilled Set damage on a part of an object.
- Groups:
- Object Manipulation
Syntax
- Syntax:
- object setHit [part, damage, useEffects, killer, instigator, breakRotor]
- Parameters:
- object: Object - local object
- part: String - name of the part (selection name)
- damage: Number - damage value ranging 0..1, 0 being fully functional, 1 being destroyed
- 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:
- Example 3:
Additional Information
- See also:
- getHit getHitPointDamage setHitPointDamage damage setDamage setFuel setAmmo getHitIndex setHitIndex 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
- Posted on Aug 24, 2009 - 11:09 (UTC)
-
Damaging specific parts of the vehicle will not update its overall damage value (as of v1.03):
- Posted on Mar 29, 2011 - 14:25 (UTC)
-
Direct use of the names of sections of the model is likely a bad practice, and will not work on some addons.
So instead:
should be used:_MH60S setHit ["elektronika", _hit];