getUnitFreefallInfo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{RV|type=command |game1= arma3 |version1= 2.10 |branch= dev |arg= local |gr1= Object Manipulation |descr= Returns unit's freefall info in array [isFalling, isInFreefallPo...")
 
m (Text replacement - "Samatra" to "Sa-Matra")
 
(5 intermediate revisions by 3 users not shown)
Line 3: Line 3:
|game1= arma3
|game1= arma3
|version1= 2.10
|version1= 2.10
|branch= dev
 


|arg= local
|arg= local
Line 9: Line 9:
|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 [[Bool]] - [[true]] if unit is falling
* isInFreefallPose [[Bool]] - [[true]] if unit is in freefall pose
* minFreefallHeight [[Number]] - current minimum freefall height (see [[setUnitFreefallHeight]])


|s1= [[getUnitFreefallInfo]] unit
|s1= [[getUnitFreefallInfo]] unit
Line 18: Line 15:
|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]]
}}
{{Note
|user= Sa-Matra
|timestamp= 20230508042625
|text= Note that command is supposed to be used on local units. When used  on a remote unit, its return (isFalling) is unreliable and sometimes returns wrong values.
}}
}}

Latest revision as of 20:58, 4 July 2024

Hover & click on the images for description

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
Sa-Matra - c
Posted on May 08, 2023 - 04:26 (UTC)
Note that command is supposed to be used on local units. When used on a remote unit, its return (isFalling) is unreliable and sometimes returns wrong values.