API reference
API reference
Select your platform
No SDKs available
No versions available
RigidbodyKinematicLockerExtension Class
Extension methods for Rigidbody to easily manage kinematic locking through the RigidbodyKinematicLocker component.
Static Member Functions
static bool IsLocked
( this Rigidbody rigidbody )
Check whether the kinematic state of the Rigidbody is locked by some other caller.
If the Rigidbody does not have a RigidbodyKinematicLocker component, it returns false.
Parameters
rigidbody
The Rigidbody to check lock status on.
Returns
Whether the rigidbody is currently locked
static void LockKinematic
( this Rigidbody rigidbody )
Locks to true the kinematic state of the Rigidbody this method is called on.
If the Rigidbody does not have a RigidbodyKinematicLocker component, it adds one.
Parameters
rigidbody
The Rigidbody to lock the kinematic state on.
static void UnlockKinematic
( this Rigidbody rigidbody )
Unlocks the kinematic state of the Rigidbody this method is called on.
If the Rigidbody does not have a RigidbodyKinematicLocker component, it logs an error.
Parameters
rigidbody
The Rigidbody to unlock the kinematic state on.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta