getHitPointDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
(Remove ServerExec icons + Some wiki formatting)
 
(47 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| TKOH |Game name=
|game1= tkoh
|1.00|Game version=
|version1= 1.00
|arg= global|Multiplayer Arguments=


|gr1= Object Manipulation |GROUP1=
|game2= arma3
____________________________________________________________________________________________
|version2= 0.50


| Return current level of damage 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]].
|arg= global
* 0: no damage
* 1: full damage |DESCRIPTION=
____________________________________________________________________________________________


| vehicle '''getHitPointDamage''' hitPointName|SYNTAX=
|gr1= Object Manipulation


|p1= vehicle : [[Object]] - vehicle to be queried |PARAMETER1=
|descr= Return current level of damage in range 0..1 for a specific Hit Point (specified by its config class).
|p2= hitPointName: [[String]] - name of the Hit Point class |PARAMETER2=
If you need to get damage of a selection instead of hit point, use [[getHit]].


| [[Number]] (or, prior to Arma 3 v1.93.145625, [[Nothing]] when invalid input is given) |RETURNVALUE=
|s1= vehicle [[getHitPointDamage]] hitPointName
____________________________________________________________________________________________


|x1= <code>[[vehicle]] [[player]] [[getHitPointDamage]] "hitEngine";</code> |=
|p1= vehicle : [[Object]] - vehicle to be queried


| [[setHitPointDamage]], [[getAllHitPointsDamage]], [[setHit]], [[getHit]], [[setDamage]], [[damage]], [[getHitIndex]], [[setHitIndex]] |SEEALSO=
|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]]
}}
}}
<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
{{Note
<!-- Note Section BEGIN -->
|user= Joris
<dt class="note">'''Unknown'''
|timestamp= 20111125150600
<dd class="note">
|text= Common [[ObjectRTD]] {{GameCategory|tkoh|link= y}} Hit Points:
Common [[ObjectRTD]] [[:Category:{{tkoh}}|{{tkoh}}]] Hit Points:
{{Columns|4|
* HitEngine (engine #1)
* HitEngine (engine #1)
* HitEngine2 (engine #2)
* HitEngine2 (engine #2)
Line 64: Line 63:
* HitGlass5
* HitGlass5
* HitGlass6
* HitGlass6
<!-- Note Section END -->
}}
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
{{GameCategory|tkoh|Scripting Commands}}
|user= K.J.
[[Category:Take On Helicopters: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
|timestamp= 20170304012900
{{GameCategory|arma3|New_Scripting_Commands_List}}
|text= 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.
{{GameCategory|arma3|Scripting Commands}}
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.
}}


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= X3KJ
<dd class="notedate">Posted on March 4, 2017 - 01:29 (UTC)</dd>
|timestamp= 20181005231200
<dt class="note">[[User:K.J.|K.J.]]</dt>
|text= Note: Since {{Name|arma3tanks}} DLC, Turrets of vanilla vehicles no longer have identical Hitpoint Classes for multiple Turrets.
<dd class="note">
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).
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>
</dl>
<!-- DISCONTINUE Notes -->
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on October 5, 2018 - 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>
<!-- DISCONTINUE Notes -->

Latest revision as of 11:34, 23 July 2024

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

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 Arma 3 logo black.png1.94, Nothing was returned when an invalid selection was provided (now returns 0)

Examples

Example 1:
vehicle player getHitPointDamage "hitEngine";

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
Joris - c
Posted on Nov 25, 2011 - 15:06 (UTC)
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
K.J. - c
Posted on Mar 04, 2017 - 01:29 (UTC)
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.
X3KJ - c
Posted on Oct 05, 2018 - 23:12 (UTC)
Note: Since Arma 3 Tanks 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).
Retrieved from "https://community.bistudio.com/wiki?title=getHitPointDamage&oldid=365086"