getUnitFreefallInfo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Bool" to "Boolean")
m (Some wiki formatting)
Line 3: Line 3:
|game1= arma3
|game1= arma3
|version1= 2.10
|version1= 2.10
|branch= dev
|branch= dev


Line 9: Line 10:
|gr1= Object Manipulation
|gr1= Object Manipulation


|descr= Returns unit's freefall info in array [isFalling, isInFreefallPose, minFreefallHeight], where
|descr= Returns a unit's freefall information.
* isFalling [[Boolean]] - [[true]] if unit is falling
* isInFreefallPose [[Boolean]] - [[true]] if unit is in freefall pose
* minFreefallHeight [[Number]] - current minimum freefall height (see [[setUnitFreefallHeight]])


|s1= [[getUnitFreefallInfo]] unit
|s1= [[getUnitFreefallInfo]] unit
Line 18: Line 16:
|p1= unit: [[Object]] - unit
|p1= unit: [[Object]] - unit


|r1= [[Array]] format [isFalling, isInFreefallPose, minFreefallHeight], where
* isFalling: [[Boolean]] - [[true]] if unit is falling
* isInFreefallPose: [[Boolean]] - [[true]] if unit is in freefall pose
* minFreefallHeight: [[Number]] - current minimum freefall height (see [[setUnitFreefallHeight]])


|r1= [[Array]] - see description
|x1= <sqf>getUnitFreefallInfo player;</sqf>
|x1= <code>[[getUnitFreefallInfo]] [[player]];</code>


|seealso= [[setUnitFreefallHeight]] [[getUserInfo]] [[getModelInfo]]
|seealso= [[setUnitFreefallHeight]] [[getUserInfo]] [[getModelInfo]]
}}
}}

Revision as of 15:12, 22 April 2022

Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.10.

Description

Description:
Returns a unit's freefall information.
Groups:
Object Manipulation

Syntax

Syntax:
getUnitFreefallInfo unit
Parameters:
unit: Object - unit
Return Value:
Array format [isFalling, isInFreefallPose, minFreefallHeight], where

Examples

Example 1:
getUnitFreefallInfo player;

Additional Information

See also:
setUnitFreefallHeight getUserInfo getModelInfo

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