UPrimitiveComponent::GetRigidBodyState

Get the state of the rigid body responsible for this Actor's physics, and fill in the supplied [FRigidBodyState](API\Runtime\Engine\Engine\FRigidBodyState) struct based on it.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Components/PrimitiveComponent.h

Include

#include "Components/PrimitiveComponent.h"

Source

/Engine/Source/Runtime/Engine/Private/PrimitiveComponentPhysics.cpp

Syntax

bool GetRigidBodyState
(
    FRigidBodyState & OutState,
    FName BoneName
)

Remarks

Get the state of the rigid body responsible for this Actor's physics, and fill in the supplied FRigidBodyState struct based on it.

Returns

true if we successfully found a physics-engine body and update the state structure from it.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss