Difference between revisions of "BIS fnc helicopterDamage"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Some wiki formatting)
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
+
{{RV|type=function
  
| tkoh |Game name=
+
|game1= tkoh
 +
|version1= 1.00
  
|1.00|Game version=
+
|game2= arma3
 +
|version2= 0.50
  
|gr1 = Helicopters |GROUP1=
+
|gr1= Helicopters
  
| Handling EH-based helicopter damage, event handler in question being [[Arma_3:_Event_Handlers#Dammaged|Da''mm''aged]]{{sic}}.  
+
|descr= Handling EH-based helicopter damage, event handler in question being [[Arma_3:_Event_Handlers#Dammaged|Da''mm''aged]]{{sic}}.  
 
<syntaxhighlight lang="cpp">params ["_helicopter", "_selection", "_damage"];</syntaxhighlight>
 
<syntaxhighlight lang="cpp">params ["_helicopter", "_selection", "_damage"];</syntaxhighlight>
 
Executed script is:
 
Executed script is:
 
<code>helicopter [[execVM]] '''"hsim\air_h\data\scripts\main_rotor_destruction.sqf"''';</code>
 
<code>helicopter [[execVM]] '''"hsim\air_h\data\scripts\main_rotor_destruction.sqf"''';</code>
 
helicopter rotor status can be found ''via'' variable '''HSim_mainRotorDestroyed''':
 
helicopter rotor status can be found ''via'' variable '''HSim_mainRotorDestroyed''':
<code>_isRotorDestroyed {{=}} helicopter [[getVariable]] ["HSim_mainRotorDestroyed", [[false]]];</code> |Description=
+
<code>_isRotorDestroyed {{=}} helicopter [[getVariable]] ["HSim_mainRotorDestroyed", [[false]]];</code>
  
| [helicopter, selection, damage] call [[BIS_fnc_helicopterDamage]] |Syntax=
+
|s1= [helicopter, selection, damage] call [[BIS_fnc_helicopterDamage]]
  
|p1= helicopter: [[Object]] |Parameter 1=
+
|p1= helicopter: [[Object]]
  
|p2= selection: [[String]] - name of the helicopter selection receiving damage. Must be "main rotor" |Parameter 2=
+
|p2= selection: [[String]] - name of the helicopter selection receiving damage. Must be "main rotor"
  
|p3= damage: [[Number]] - ''selection'''s damage. Will only trigger effects if ''damage'' &gt; 0.999 |Parameter 3=
+
|p3= damage: [[Number]] - ''selection'''s damage. Will only trigger effects if ''damage'' &gt; 0.999
  
| [[Boolean]] - [[true]] when done |Return value=
+
|r1= [[Boolean]] - [[true]] when done
  
|x1= <code>myHelicopter [[addEventHandler]] ["Dammaged", { [[_this]] [[call]] [[BIS_fnc_helicopterDamage]]; }];</code> |Example 1=
+
|x1= <code>myHelicopter [[addEventHandler]] ["Dammaged", { [[Magic Variables#this|_this]] [[call]] [[BIS_fnc_helicopterDamage]]; }];</code>
  
| |See also=
+
|seealso=
 
}}
 
}}
 
<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
 
<!-- Note Section END -->
 
</dl>
 
 
<h3 style="display:none">Bottom Section</h3>
 
 
[[Category:Functions|{{uc:helicopterDamage}}]]
 
[[Category:{{Name|tkoh}}: Functions|{{uc:helicopterDamage}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:helicopterDamage}}]]
 

Latest revision as of 00:49, 14 June 2021

Hover & click on the images for description

Description

Description:
Handling EH-based helicopter damage, event handler in question being Dammagedsic.
params ["_helicopter", "_selection", "_damage"];

Executed script is: helicopter execVM "hsim\air_h\data\scripts\main_rotor_destruction.sqf"; helicopter rotor status can be found via variable HSim_mainRotorDestroyed:

_isRotorDestroyed = helicopter getVariable ["HSim_mainRotorDestroyed", false];
Execution:
call
Groups:
Helicopters

Syntax

Syntax:
[helicopter, selection, damage] call BIS_fnc_helicopterDamage
Parameters:
helicopter: Object
selection: String - name of the helicopter selection receiving damage. Must be "main rotor"
damage: Number - selection's damage. Will only trigger effects if damage > 0.999
Return Value:
Boolean - true when done

Examples

Example 1:
myHelicopter addEventHandler ["Dammaged", { _this call BIS_fnc_helicopterDamage; }];

Additional Information

See also:
See also needed

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