unreal.AnimCharacterMovementLibrary

class unreal.AnimCharacterMovementLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Library of common techniques for driving character locomotion animations.

C++ Source:

  • Plugin: AnimationLocomotionLibrary

  • Module: AnimationLocomotionLibraryRuntime

  • File: AnimCharacterMovementLibrary.h

classmethod predict_ground_movement_pivot_location(acceleration, velocity, ground_friction) → Vector

Predict where the character will change direction during a pivot based on its current movement properties and parameters from the movement component. This uses prediction logic that is heavily tied to the UCharacterMovementComponent. Each parameter corresponds to a value from the UCharacterMovementComponent with the same name. Because this is a thread safe function, it’s recommended to populate these fields via the Property Access system.

Parameters
Returns

The predicted pivot position in local space to the character. The size of this vector will be the distance to the pivot.

Return type

Vector

classmethod predict_ground_movement_stop_location(velocity, use_separate_braking_friction, braking_friction, ground_friction, braking_friction_factor, braking_deceleration_walking) → Vector

Predict where the character will stop based on its current movement properties and parameters from the movement component. This uses prediction logic that is heavily tied to the UCharacterMovementComponent. Each parameter corresponds to a value from the UCharacterMovementComponent with the same name. Because this is a thread safe function, it’s recommended to populate these fields via the Property Access system.

Parameters

  • velocity (Vector) –

  • use_separate_braking_friction (bool) –

  • braking_friction (float) –

  • ground_friction (float) –

  • braking_friction_factor (float) –

  • braking_deceleration_walking (float) –

Returns

The predicted stop position in local space to the character. The size of this vector will be the distance to the stop location.

Return type

Vector