setHit: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
Line 20: Line 20:


|descr= Set damage on a part of an object.
|descr= Set damage on a part of an object.
{{Feature | Informative | Some part names are in Czech; see [[Translations|translation table]]. }}
{{Feature|Informative|Some part names are in Czech; see the [[ArmA: Armed Assault: Selection Translations|translation table]].}}


|s1= object [[setHit]] [part, damage, useEffects, instigator]
|s1= object [[setHit]] [part, damage, useEffects, instigator]


|p1= [part, damage, useEffects]: [[Array]]
|p1= object: [[Object]] - [[local]] object


|p2= object: [[Object]] - [[local]] object
|p2= part: [[String]] - Name of the part ([[Named_Selection|selection]] name)


|p3= 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= 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= {{GVI|arma3|1.68}} useEffects: [[Boolean]] - (Optional, default [[true]]) [[false]] to skip destruction effects
|p5= instigator: [[Object]] - (Optional, default [[objNull]]) The object that caused the damage. If the damage leads to the death of the unit, the instigator 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).
|p6= {{GVI|arma3|2.08}} instigator: [[Object]] - (Optional, default [[objNull]]) The object that caused the damage. If the damage leads to the death of the unit, the instigator will be used as the object that caused the kill. <br>
* it will alter the instigator's [[rating]] as if the instigator directly killed the unit.
* 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 be listed as {{ic|_killer}} parameter in the [[Arma 3: Event Handlers#Killed|Killed]] event handler.
* It will alter the instigator's [[rating]] as if the instigator directly killed the unit. <br>
|p5since= arma3 2.08
* It will be listed as {{ic|_killer}} parameter in the [[Arma_3:_Event_Handlers#Killed|Killed]] event handler.


|r1= [[Nothing]]
|r1= [[Nothing]]
Line 45: Line 45:
|x2= <code>[[vehicle]] [[player]] [[setHit]] ["mala vrtule", 0.95];</code>
|x2= <code>[[vehicle]] [[player]] [[setHit]] ["mala vrtule", 0.95];</code>


|x3= <code>[[if]] ([[local]] _heli) [[then]] {
|x3= <code>[[if]] ([[local]] _heli) [[then]]
{
_heli [[setHit]] ["velka vrtule", 0];
_heli [[setHit]] ["velka vrtule", 0];
} [[else]] {
}
[[else]]
{
[[hint]] ("Vehicle " + [[str]] _heli + " must be local to this machine to do that!");
[[hint]] ("Vehicle " + [[str]] _heli + " must be local to this machine to do that!");
};</code>
};</code>
Line 54: Line 57:
}}
}}


<dl class="command_description">
{{Note
 
|user= Deadfast
<dt><dt>
|timestamp= 20090824110900
<dd class="notedate">
|text= Damaging specific parts of the vehicle will not update its overall [[damage]] value (as of v1.03):
<dt class="note">[[User:Deadfast|Deadfast]]</dt>
<dd class="note">Damaging specific parts of the vehicle will not update its overall [[damage]] value (as of v1.03):
<code>[[player]] [[setHit]] ["hands", 0.9];
<code>[[player]] [[setHit]] ["hands", 0.9];
[[hint]] [[str]] ([[damage]] [[player]]); {{cc|will return 0}}</code>
[[hint]] [[str]] ([[damage]] [[player]]); {{cc|will return 0}}</code>
<dt><dt>
|game= arma2
<dd class="notedate">
}}
<dt class="note">[[User:DenV|denisko.redisko]]</dt>
 
<dd class="note">Direct use of the names of sections of the model is likely a bad practice, and will not work on some addons.
{{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:
<code>_MH60S [[setHit]] ["elektronika", _hit];</code>
<code>_MH60S [[setHit]] ["elektronika", _hit];</code>
should be used:
should be used:
<code>_MH60S [[setHit]] [<nowiki/>[[getText]] ([[configFile]] >> "cfgVehicles" >> "MH60S" >> "HitPoints" >> "HitAvionics" >> "name"), _hit];</code>
<code>_MH60S [[setHit]] [<nowiki/>[[getText]] ([[configFile]] >> "cfgVehicles" >> "MH60S" >> "HitPoints" >> "HitAvionics" >> "name"), _hit];</code>
 
}}
<dt></dt>
<dd class="notedate">Posted on September 11, 2018 - 19:37 (UTC)</dd>
<dt class="note">[[User:HazJ|HazJ]]</dt>
<dd class="note">
You can use [[getHit]] if you are using 1.64 EOL version.
</dd>
 
</dl>

Revision as of 16:24, 24 November 2021

Hover & click on the images for description

Description

Description:
Set damage on a part of an object.
Some part names are in Czech; see the translation table.
Groups:
Object Manipulation

Syntax

Syntax:
object setHit [part, damage, useEffects, instigator]
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 Arma 3 logo black.png1.68
useEffects: Boolean - (Optional, default true) false to skip destruction effects
since Arma 3 logo black.png2.08
instigator: Object - (Optional, default objNull) The object that caused the damage. If the damage leads to the death of the unit, the instigator 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 instigator's rating as if the instigator directly killed the unit.
  • it will be listed as _killer parameter in the Killed event handler.
Return Value:
Nothing

Examples

Example 1:
vehicle player setHit ["motor", 1];
Example 2:
vehicle player setHit ["mala vrtule", 0.95];
Example 3:
if (local _heli) then { _heli setHit ["velka vrtule", 0]; } else { hint ("Vehicle " + str _heli + " must be local to this machine to do that!"); };

Additional Information

See also:
getHitgetHitPointDamagesetHitPointDamagedamagesetDamagesetFuelsetAmmogetHitIndexsetHitIndex

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
Deadfast - c
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): player setHit ["hands", 0.9]; hint str (damage player); // will return 0

DenV - c
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: _MH60S setHit ["elektronika", _hit]; should be used: _MH60S setHit [getText (configFile >> "cfgVehicles" >> "MH60S" >> "HitPoints" >> "HitAvionics" >> "name"), _hit];