unreal.BasedMovementUtils

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

Bases: BlueprintFunctionLibrary

MovementBaseUtils: a collection of stateless static BP-accessible functions for based movement

C++ Source:

  • Plugin: Mover

  • Module: Mover

  • File: BasedMovementUtils.h

classmethod get_movement_base_transform(movement_base, bone_name) → (out_location=Vector, out_quat=Quat) or None

Get the transform (local-to-world) for the given MovementBase, optionally at the location of a bone. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone.

Parameters:
Returns:

out_location (Vector):

out_quat (Quat):

Return type:

tuple or None

classmethod is_a_dynamic_base(movement_base) → bool

Determine whether MovementBase can possibly move.

Parameters:

movement_base (PrimitiveComponent) –

Return type:

bool

classmethod is_base_simulating_physics(movement_base) → bool

Determine whether MovementBase’s movement is performed via physics.

Parameters:

movement_base (PrimitiveComponent) –

Return type:

bool

classmethod transform_based_direction_to_world(movement_base, bone_name, local_direction) → Vector or None

Convert a local direction to a world direction for a given MovementBase. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:
Returns:

out_direction_world_space (Vector):

Return type:

Vector or None

classmethod transform_based_location_to_world(movement_base, bone_name, local_location) → Vector or None

Convert a local location to a world location for a given MovementBase. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:
Returns:

out_location_world_space (Vector):

Return type:

Vector or None

classmethod transform_based_rotator_to_world(movement_base, bone_name, local_rotator) → Rotator or None

Convert a local rotator to world space for a given MovementBase. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:
Returns:

out_world_space_rotator (Rotator):

Return type:

Rotator or None

classmethod transform_direction_to_local(base_quat, world_space_direction) → Vector

Convert a world direction to a local direction for a given MovementBase, optionally relative to the orientation of a bone. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:

  • base_quat (Quat) –

  • world_space_direction (Vector) –

Returns:

out_local_direction (Vector):

Return type:

Vector

classmethod transform_direction_to_world(base_quat, local_direction) → Vector

Convert a local direction to a world direction for a given MovementBase. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:

  • base_quat (Quat) –

  • local_direction (Vector) –

Returns:

out_direction_world_space (Vector):

Return type:

Vector

classmethod transform_location_to_local(base_pos, base_quat, world_space_location) → Vector

Convert a world location to a local location for a given MovementBase, optionally at the location of a bone. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:
Returns:

out_local_location (Vector):

Return type:

Vector

classmethod transform_location_to_world(base_pos, base_quat, local_location) → Vector

Convert a local location to a world location for a given MovementBase. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:
Returns:

out_location_world_space (Vector):

Return type:

Vector

classmethod transform_rotator_to_local(base_quat, world_space_rotator) → Rotator

Convert a world space rotator to a local rotator for a given MovementBase, optionally relative to the orientation of a bone. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:

  • base_quat (Quat) –

  • world_space_rotator (Rotator) –

Returns:

out_local_rotator (Rotator):

Return type:

Rotator

classmethod transform_rotator_to_world(base_quat, local_rotator) → Rotator

Convert a local rotator to world space for a given MovementBase. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:
Returns:

out_world_space_rotator (Rotator):

Return type:

Rotator

classmethod transform_world_direction_to_based(movement_base, bone_name, world_space_direction) → Vector or None

Convert a world direction to a local direction for a given MovementBase, optionally relative to the orientation of a bone. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:
Returns:

out_local_direction (Vector):

Return type:

Vector or None

classmethod transform_world_location_to_based(movement_base, bone_name, world_space_location) → Vector or None

Convert a world location to a local location for a given MovementBase, optionally at the location of a bone. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:
Returns:

out_local_location (Vector):

Return type:

Vector or None

classmethod transform_world_rotator_to_based(movement_base, bone_name, world_space_rotator) → Rotator or None

Convert a world space rotator to a local rotator for a given MovementBase, optionally relative to the orientation of a bone. Returns false if MovementBase is nullptr, or if BoneName is not a valid bone. Scaling is ignored.

Parameters:
Returns:

out_local_rotator (Rotator):

Return type:

Rotator or None