BIS fnc helicopterType: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *H([a-z ])" to "$1 - h$2")
 
(35 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| tkoh |= Game name
|game2= arma3
|version2= 0.50


|1.00|= Game version
|gr1= Helicopters
____________________________________________________________________________________________


| <pre>/*
|descr= Returns helicopter type.


Description:
|s1= [object] call [[BIS_fnc_helicopterType]]
Returns helicopter type


Parameter(s):
|p1= start: [[Object]] - helicopter to be checked.
_this: OBJECT - Helicopter


Returns:
|r1= [[Number]] - one of:
NUMBER
* -1 - Unknown
-1 - Not recognized
* &nbsp;0 - Light
0 - Light
* &nbsp;1 - Medium
1 - Medium
* &nbsp;2 - Heavy
2 - Heavy
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|x1= <sqf>private _helicopterType = [vehicle player] call BIS_fnc_helicopterType;</sqf>
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_helicopterType]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[typeOf]]
}}
}}
<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:Function Group: Helicopters|{{uc:helicopterType}}]]
[[Category:Functions|{{uc:helicopterType}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:helicopterType}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:helicopterType}}]]

Latest revision as of 16:32, 8 November 2023

Hover & click on the images for description

Description

Description:
Returns helicopter type.
Execution:
call
Groups:
Helicopters

Syntax

Syntax:
[object] call BIS_fnc_helicopterType
Parameters:
start: Object - helicopter to be checked.
Return Value:
Number - one of:
  • -1 - Unknown
  •  0 - Light
  •  1 - Medium
  •  2 - Heavy

Examples

Example 1:
private _helicopterType = [vehicle player] call BIS_fnc_helicopterType;

Additional Information

See also:
typeOf

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