BIS fnc getPitchBank: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add Argument Effect Global and getDir link)
m (Text replacement - "Numbers" to "Numbers")
 
(38 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|arg= global |arguments=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Returns the pitch and bank of an object, in degrees. '''Yaw''' can be found using the [[getDir]] command.<br />
|game4= arma3
'''Pitch''' is 0 when the object is level; 90 when pointing straight up; and -90 when pointing straight down.<br />
|version4= 0.50
'''Bank''' is 0 when level; 90 when the object is rolled to the right, -90 when rolled to the left, and 180 when rolled upside down.


{{Important|The '''bank''' returned by this command is not fully accurate, it can be off by up to 5% or so (depending on pitch) due to an unknown bug.}} |Description=
|gr1= Object Manipulation
____________________________________________________________________________________________


| object call [[BIS_fnc_getPitchBank]] |Syntax=
|arg= global


|p1= object: [[Object]] |Parameter 1=
|descr= Returns the pitch and bank of an object, in degrees. '''Yaw''' can be found using the [[getDir]] command.<br>
'''Pitch''' is 0 when the object is level; 90 when pointing straight up; and -90 when pointing straight down.<br>
'''Bank''' is 0 when level; 90 when the object is rolled to the right, -90 when rolled to the left, and 180 when rolled upside down.


| [[Array]] of [[Number|Numbers]] - format [pitch, bank] |Return value=
{{Feature|important|The '''bank''' returned by this command is not fully accurate, it can be off by up to 5% or so (depending on pitch) due to an unknown bug.}}
____________________________________________________________________________________________


|x1= <code>_pitchBank = [[vehicle]] [[player]] [[call]] [[BIS_fnc_getPitchBank]];</code> |Example 1=
|s1= object call [[BIS_fnc_getPitchBank]]
____________________________________________________________________________________________


| [[BIS_fnc_setPitchBank]], [[vectorDir]], [[vectorUp]], [[setVectorDirAndUp]] |See also=
|p1= object: [[Object]]
}}


<h3 style="display:none">Notes</h3>
|r1= [[Array]] of [[Number]]s - format [pitch, bank]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>private _pitchBank = vehicle player call BIS_fnc_getPitchBank;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[BIS_fnc_setPitchBank]] [[vectorDir]] [[vectorUp]] [[setVectorDirAndUp]]
[[Category:Functions|{{uc:getPitchBank}}]]
}}
[[Category:Function Group: Objects|{{uc:getPitchBank}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:getPitchBank}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:getPitchBank}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:getPitchBank}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getPitchBank}}]]

Latest revision as of 23:38, 12 July 2022

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

Description

Description:
Returns the pitch and bank of an object, in degrees. Yaw can be found using the getDir command.
Pitch is 0 when the object is level; 90 when pointing straight up; and -90 when pointing straight down.
Bank is 0 when level; 90 when the object is rolled to the right, -90 when rolled to the left, and 180 when rolled upside down.
⚠
The bank returned by this command is not fully accurate, it can be off by up to 5% or so (depending on pitch) due to an unknown bug.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
object call BIS_fnc_getPitchBank
Parameters:
object: Object
Return Value:
Array of Numbers - format [pitch, bank]

Examples

Example 1:
private _pitchBank = vehicle player call BIS_fnc_getPitchBank;

Additional Information

See also:
BIS_fnc_setPitchBank vectorDir vectorUp setVectorDirAndUp

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_getPitchBank&oldid=327553"