unreal.PhysicsHandleComponent

class unreal.PhysicsHandleComponent(outer: Object | None = None, name: Name | str = 'None')

Bases: ActorComponent

Utility object for moving physics objects around.

C++ Source:

  • Module: Engine

  • File: PhysicsHandleComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • angular_damping (float): [Read-Write] Angular damping of the handle spring

  • angular_stiffness (float): [Read-Write] Angular stiffness of the handle spring

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • component_tags (Array[Name]): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • interpolate_target (bool): [Read-Write]

  • interpolation_speed (float): [Read-Write] How quickly we interpolate the physics target transform

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • linear_damping (float): [Read-Write] Linear damping of the handle spring.

  • linear_stiffness (float): [Read-Write] Linear stiffness of the handle spring

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • replicate_using_registered_sub_object_list (bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • soft_angular_constraint (bool): [Read-Write]

  • soft_linear_constraint (bool): [Read-Write]

property angular_damping: float

[Read-Only] Angular damping of the handle spring

Type:

(float)

property angular_stiffness: float

[Read-Only] Angular stiffness of the handle spring

Type:

(float)

get_grabbed_component() → PrimitiveComponent

Returns the currently grabbed component, or null if nothing is grabbed.

Return type:

PrimitiveComponent

get_target_location_and_rotation() -> (target_location=Vector, target_rotation=Rotator)

Get the current location and rotation

Returns:

target_location (Vector):

target_rotation (Rotator):

Return type:

tuple

grab_component(component, bone_name, grab_location, constrain_rotation) → None

Grab Component deprecated: Please use GrabComponentAtLocation or GrabComponentAtLocationWithRotation

Parameters:
grab_component_at_location(component, bone_name, grab_location) → None

Grab the specified component at a given location. Does NOT constraint rotation which means the handle will pivot about GrabLocation.

Parameters:
grab_component_at_location_with_rotation(component, bone_name, location, rotation) → None

Grab the specified component at a given location and rotation. Constrains rotation.

Parameters:
property interpolate_target: bool

[Read-Write]

Type:

(bool)

property interpolation_speed: float

[Read-Only] How quickly we interpolate the physics target transform

Type:

(float)

property linear_damping: float

[Read-Only] Linear damping of the handle spring.

Type:

(float)

property linear_stiffness: float

[Read-Only] Linear stiffness of the handle spring

Type:

(float)

release_component() → None

Release the currently held component

set_angular_damping(new_angular_damping) → None

Set angular damping

Parameters:

new_angular_damping (float) –

set_angular_stiffness(new_angular_stiffness) → None

Set angular stiffness

Parameters:

new_angular_stiffness (float) –

set_interpolation_speed(new_interpolation_speed) → None

Set interpolation speed

Parameters:

new_interpolation_speed (float) –

set_linear_damping(new_linear_damping) → None

Set linear damping

Parameters:

new_linear_damping (float) –

set_linear_stiffness(new_linear_stiffness) → None

Set linear stiffness

Parameters:

new_linear_stiffness (float) –

set_target_location(new_location) → None

Set the target location

Parameters:

new_location (Vector) –

set_target_location_and_rotation(new_location, new_rotation) → None

Set target location and rotation

Parameters:
set_target_rotation(new_rotation) → None

Set the target rotation

Parameters:

new_rotation (Rotator) –

property soft_angular_constraint: bool

[Read-Only]

Type:

(bool)

property soft_linear_constraint: bool

[Read-Only]

Type:

(bool)