isAwake: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{RV|type=command |game1= arma3 |version1= 2.08 |branch= dev |arg= global |eff= local |gr1= Object Manipulation |descr= Wakes up sleeping PhysX object or puts a PhysX obje...")
 
No edit summary
Line 10: Line 10:
|gr1= Object Manipulation
|gr1= Object Manipulation


|descr= Wakes up sleeping PhysX object or puts a PhysX object to sleep.
|descr= Returns resting state of a PhysX object. If object of class <tt>Man</tt> is used for the argument, the command returns [[false]] if ragdoll simulation is active and [[true]] if there is no ragdoll simulation. Destroyed and null objects return [[false]].
{{Feature | Informative | This command won't have lasing effect on vehicles as vehicles are actively simulated, but it works rather well on smaller PhysX enabled objects}}
|s1= object [[awake]] awake


|p1= object: [[Object]] - PhysX object
|s1= [[isAwake]] object


|p2= awake: [[Boolean]] - [[true]] to awake the object, [[false]] - to put to sleep
|p1= object: [[Object]] - PhysX object or unit


|r1= [[Nothing]]
|r1= [[Boolean]]


|x1= <code>_object [[awake]] [[false]];</code>
|x1= <code>_isAwake = [[isAwake]] _object;</code>


|seealso= [[isAwake]] [[addTorque]] [[addForce]] [[vectorModelToWorld]] [[vectorModelToWorldVisual]] [[selectionPosition]]
|seealso= [[awake]] [[addTorque]] [[addForce]] [[vectorModelToWorld]] [[vectorModelToWorldVisual]] [[selectionPosition]]
}}
}}

Revision as of 12:09, 4 November 2021

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

Description

Description:
Returns resting state of a PhysX object. If object of class Man is used for the argument, the command returns false if ragdoll simulation is active and true if there is no ragdoll simulation. Destroyed and null objects return false.
Groups:
Object Manipulation

Syntax

Syntax:
isAwake object
Parameters:
object: Object - PhysX object or unit
Return Value:
Boolean

Examples

Example 1:
_isAwake = isAwake _object;

Additional Information

See also:
awake addTorque addForce vectorModelToWorld vectorModelToWorldVisual selectionPosition

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