unreal.PhysicsControlBPLibrary

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

Bases: BlueprintFunctionLibrary

Physics Control BPLibrary

C++ Source:

  • Plugin: PhysicsControl

  • Module: PhysicsControl

  • File: PhysicsControlBPLibrary.h

classmethod add_control_parameters(parameters, name, control_data) -> (parameters=PhysicsControlControlAndModifierParameters, out_parameters=PhysicsControlControlAndModifierParameters)

Add a single control parameter Parameters to a set of parameter Parameters.

Parameters:
Returns:

parameters (PhysicsControlControlAndModifierParameters):

out_parameters (PhysicsControlControlAndModifierParameters):

Return type:

tuple

classmethod add_modifier_parameters(parameters, name, modifier_data) -> (parameters=PhysicsControlControlAndModifierParameters, out_parameters=PhysicsControlControlAndModifierParameters)

Add a single body modifier parameter Parameters to a set of parameter Parameters.

Parameters:
Returns:

parameters (PhysicsControlControlAndModifierParameters):

out_parameters (PhysicsControlControlAndModifierParameters):

Return type:

tuple

classmethod add_multiple_control_parameters(parameters, names, control_data) -> (parameters=PhysicsControlControlAndModifierParameters, out_parameters=PhysicsControlControlAndModifierParameters)

Add a single control parameter Parameters to a set of parameter Parameters.

Parameters:
Returns:

parameters (PhysicsControlControlAndModifierParameters):

out_parameters (PhysicsControlControlAndModifierParameters):

Return type:

tuple

classmethod add_multiple_modifier_parameters(parameters, names, modifier_data) -> (parameters=PhysicsControlControlAndModifierParameters, out_parameters=PhysicsControlControlAndModifierParameters)

Add a single body modifier parameter Parameters to a set of parameter Parameters.

Parameters:
Returns:

parameters (PhysicsControlControlAndModifierParameters):

out_parameters (PhysicsControlControlAndModifierParameters):

Return type:

tuple

classmethod blend_control_parameters_through_set(parameters, start_control_parameters, end_control_parameters, control_names) -> (parameters=PhysicsControlControlAndModifierParameters, out_parameters=PhysicsControlControlAndModifierParameters)

Adds an Parameters to the output parameters for each control name in the supplied set. The values in each Parameters will be a linear interpolation of the two supplied Parameters, blending from the start Parameters to the end Parameters across the elements in the set.

Parameters:
Returns:

parameters (PhysicsControlControlAndModifierParameters):

out_parameters (PhysicsControlControlAndModifierParameters):

Return type:

tuple

classmethod blend_modifier_parameters_through_set(parameters, start_modifier_parameters, end_modifier_parameters, modifier_names) -> (parameters=PhysicsControlControlAndModifierParameters, out_parameters=PhysicsControlControlAndModifierParameters)

Adds an Parameters to the output parameters for each modifier name in the supplied set. The values in each Parameters will be a linear interpolation of the two supplied Parameters, blending from the start Parameters to the end Parameters across the elements in the set.

Parameters:
Returns:

parameters (PhysicsControlControlAndModifierParameters):

out_parameters (PhysicsControlControlAndModifierParameters):

Return type:

tuple

classmethod blend_parameters(parameters_a, parameters_b, interpolation_weight) -> (parameters_a=PhysicsControlControlAndModifierParameters, parameters_b=PhysicsControlControlAndModifierParameters, out_parameters=PhysicsControlControlAndModifierParameters)

Returns the linear interpolation of two sets of parameter Parameters. Any Parameters that exists in one of the input sets but not the other will be added to the output with a weight of 1.

Parameters:
Returns:

parameters_a (PhysicsControlControlAndModifierParameters):

parameters_b (PhysicsControlControlAndModifierParameters):

out_parameters (PhysicsControlControlAndModifierParameters):

Return type:

tuple

classmethod convert_to_rigid_body_with_control(node) -> (RigidBodyWithControlReference, result=AnimNodeReferenceConversionResult)

Get a Rigid Body With Control node reference from an anim node reference

Parameters:

node (AnimNodeReference) –

Returns:

result (AnimNodeReferenceConversionResult):

Return type:

AnimNodeReferenceConversionResult

classmethod convert_to_rigid_body_with_control_pure(node) -> (rigid_body_with_control=RigidBodyWithControlReference, result=bool)

Get a Rigid Body With Control node from an anim node (pure)

Parameters:

node (AnimNodeReference) –

Returns:

rigid_body_with_control (RigidBodyWithControlReference):

result (bool):

Return type:

tuple

classmethod get_body_modifier_names_in_set(rigid_body_with_control, set_name) → Array[Name]

Get the names of all the body modifiers in a specified set managed by this Rigid Body With Control node.

Parameters:
Return type:

Array[Name]

classmethod get_control_names_in_set(rigid_body_with_control, set_name) → Array[Name]

Get the names of all the controls in a specified set managed by this Rigid Body With Control node.

Parameters:
Return type:

Array[Name]

classmethod set_override_physics_asset(node, physics_asset) → RigidBodyWithControlReference

Set the physics asset on the rigid body with control anim graph node (RBWC).

Parameters:
Return type:

RigidBodyWithControlReference