unreal.DistanceCurveModifier

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

Bases: AnimationModifier

Extracts traveling distance information from root motion and bakes it to a curve. A negative value indicates distance remaining to a stop or pivot point. A positive value indicates distance traveled from a start point or from the beginning of the clip.

C++ Source:

  • Plugin: AnimationLocomotionLibrary

  • Module: AnimationLocomotionLibraryEditor

  • File: DistanceCurveModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

  • axis (DistanceCurve_Axis): [Read-Write] Axes to calculate the distance value from.

  • curve_name (Name): [Read-Write] Name for the generated curve.

  • reapply_post_owner_change (bool): [Read-Write] If this is set to true then the animation modifier will call it’s reapply function after any change made to the owning asset.

  • sample_rate (int32): [Read-Write] Rate used to sample the animation.

  • stop_at_end (bool): [Read-Write] Root motion is considered to be stopped at the clip’s end

  • stop_speed_threshold (float): [Read-Write] Root motion speed must be below this threshold to be considered stopped.

property axis: DistanceCurve_Axis

[Read-Write] Axes to calculate the distance value from.

Type:

(DistanceCurve_Axis)

property curve_name: Name

[Read-Write] Name for the generated curve.

Type:

(Name)

property stop_at_end: bool

[Read-Write] Root motion is considered to be stopped at the clip’s end

Type:

(bool)

property stop_speed_threshold: float

[Read-Write] Root motion speed must be below this threshold to be considered stopped.

Type:

(float)