getHitPointDamage: Difference between revisions
Jump to navigation
Jump to search
(First draft documentation for new TKOH command) |
Lou Montana (talk | contribs) m (Text replacement - ">Posted on November ([0-9]{2})[ a-zA-Z]*, ([0-9]{4})" to ">Posted on $2-11-$1") |
||
| (72 intermediate revisions by 11 users not shown) | |||
| Line 1: | Line 1: | ||
{{RV|type=command | |||
|game1= tkoh | |||
|version1= 1.00 | |||
| | |game2= arma3 | ||
|version2= 0.50 | |||
| | |arg= global | ||
| | |gr1= Object Manipulation | ||
| | |descr= Return current level of damage in range 0..1 for a specific Hit Point (specified by its config class). | ||
If you need to get damage of a selection instead of hit point, use [[getHit]]. | |||
| | |s1= vehicle [[getHitPointDamage]] hitPointName | ||
| [[ | |p1= vehicle : [[Object]] - vehicle to be queried | ||
|p2= hitPointName: [[String]] - name of the Hit Point class | |||
| | |r1= [[Number]] - before {{GVI|arma3|1.94|size= 0.75}}, [[Nothing]] was returned when an invalid ''selection'' was provided (now returns {{hl|0}}) | ||
| | |x1= <sqf>vehicle player getHitPointDamage "hitEngine";</sqf> | ||
|seealso= [[setHitPointDamage]] [[getAllHitPointsDamage]] [[setHit]] [[getHit]] [[setDamage]] [[damage]] [[getHitIndex]] [[setHitIndex]] | |||
}} | }} | ||
<dl class="command_description"> | |||
< | <dt></dt> | ||
< | <dd class="notedate">Posted on 2011-11-25 - 15:06 (UTC)</dd> | ||
< | <dt class="note">[[User:Joris|Joris]]</dt> | ||
Common [[ObjectRTD]] [[:Category: | <dd class="note"> | ||
Common [[ObjectRTD]] [[:Category:{{tkoh}}|{{tkoh}}]] Hit Points: | |||
{{Columns|4| | |||
* HitEngine (engine #1) | * HitEngine (engine #1) | ||
* HitEngine2 (engine #2) | * HitEngine2 (engine #2) | ||
| Line 63: | Line 64: | ||
* HitGlass5 | * HitGlass5 | ||
* HitGlass6 | * HitGlass6 | ||
< | }} | ||
</dd> | |||
<dt></dt> | |||
<dd class="notedate">Posted on 2017-03-04 - 01:29 (UTC)</dd> | |||
<dt class="note">[[User:K.J.|K.J.]]</dt> | |||
<dd class="note"> | |||
Note that vehicles with multiple turrets have multiple HitTurret and HitGun classes that can't be distinguished based on the Hitpoint class name. They can only be distinguished by their selection names. The selection names do not necessarily correspond to a common nomenclature, especially for mod vehicles. There can also be multiple empty Hitpoint Class names on a vehicle or infantry unit. They can be hitpoints for vehicle headlights or be the result of a bad config/model, as hitpoints that have an undefined named selection in their config class or are missing their named selection in the model will result in an empty HitPoint class name. | |||
</dd> | |||
<dt><dt> | |||
<dd class="notedate">Posted on 2018-10-05 - 23:12 (UTC)</dd> | |||
<dt class="note">[[User:x3kj|x3kj]]</dt> | |||
<dd class="note"> | |||
Note: Since Arma 3 Tank DLC, Turrets of vanilla vehicles no longer have identical Hitpoint Classes for multiple Turrets. Mod vehicles may still have the old issue, but they produces error messages in RPT if they still do (and thus should be enough motivation to fix them). | |||
</dd> | |||
</dl> | </dl> | ||
Latest revision as of 00:13, 14 May 2023
Description
- Description:
- Return current level of damage in range 0..1 for a specific Hit Point (specified by its config class). If you need to get damage of a selection instead of hit point, use getHit.
- Groups:
- Object Manipulation
Syntax
- Syntax:
- vehicle getHitPointDamage hitPointName
- Parameters:
- vehicle : Object - vehicle to be queried
- hitPointName: String - name of the Hit Point class
- Return Value:
- Number - before
1.94, Nothing was returned when an invalid selection was provided (now returns 0)
Examples
- Example 1:
Additional Information
- See also:
- setHitPointDamage getAllHitPointsDamage setHit getHit setDamage damage getHitIndex setHitIndex
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 2011-11-25 - 15:06 (UTC)
- Joris
-
Common ObjectRTD Take On Helicopters Hit Points:
- HitEngine (engine #1)
- HitEngine2 (engine #2)
- HitEngine3 (engine #3)
- HitHRotor (main rotor)
- HitVRotor (tail rotor)
- HitBatteries (electrical systems)
- HitLight (landing light)
- HitHydraulics (entire hydraulics system)
- HitTransmission (engine transmission)
- HitGear (landing gear)
- HitFuel (all fuel tanks)
- HitHStabilizerL1 (first left horizontal stabilizer)
- HitHStabilizerR1 (first right horizontal stabilizer)
- HitVStabilizer1 (first vertical stabilizer)
- HitTail (tail boom)
- HitPitotTube (all pitot tubes)
- HitStaticPort (all static ports)
- HitStarter1 (starter for engine #1)
- HitStarter2 (starter for engine #2)
- HitStarter3 (starter for engine #3)
- HitAvionics
- HitHull
- HitMissiles
- HitRGlass
- HitLGlass
- HitGlass1
- HitGlass2
- HitGlass3
- HitGlass4
- HitGlass5
- HitGlass6
- Posted on 2017-03-04 - 01:29 (UTC)
- K.J.
- Note that vehicles with multiple turrets have multiple HitTurret and HitGun classes that can't be distinguished based on the Hitpoint class name. They can only be distinguished by their selection names. The selection names do not necessarily correspond to a common nomenclature, especially for mod vehicles. There can also be multiple empty Hitpoint Class names on a vehicle or infantry unit. They can be hitpoints for vehicle headlights or be the result of a bad config/model, as hitpoints that have an undefined named selection in their config class or are missing their named selection in the model will result in an empty HitPoint class name.
- Posted on 2018-10-05 - 23:12 (UTC)
- x3kj
- Note: Since Arma 3 Tank DLC, Turrets of vanilla vehicles no longer have identical Hitpoint Classes for multiple Turrets. Mod vehicles may still have the old issue, but they produces error messages in RPT if they still do (and thus should be enough motivation to fix them).