unreal.RootMotionModifier_Warp

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

Bases: RootMotionModifier

Root Motion Modifier Warp

C++ Source:

  • Plugin: MotionWarping

  • Module: MotionWarping

  • File: RootMotionModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

  • actual_start_time (float): [Read-Write] Actual playback time when the modifier becomes active

  • add_translation_easing_curve (CurveFloat): [Read-Write] Custom curve used to add translation when there is none to warp. Only relevant when AddTranslationEasingFunc is set to Custom

  • add_translation_easing_func (AlphaBlendOption): [Read-Write] Easing function used when adding translation. Only relevant when there is no translation in the animation

  • animation (AnimSequenceBase): [Read-Write] Source of the root motion we are warping

  • current_position (float): [Read-Write] Current playback time of the animation

  • end_time (float): [Read-Write] End time of the warping window

  • ignore_z_axis (bool): [Read-Write] Whether to ignore the Z component of the translation. Z motion will remain untouched

  • play_rate (float): [Read-Write] Current play rate of the animation

  • previous_position (float): [Read-Write] Previous playback time of the animation

  • rotation_method (MotionWarpRotationMethod): [Read-Write] The method of rotation to use

  • rotation_type (MotionWarpRotationType): [Read-Write] Whether rotation should be warp to match the rotation of the sync point or to face the sync point

  • start_time (float): [Read-Write] Start time of the warping window

  • start_transform (Transform): [Read-Write] Character owner transform at the time this modifier becomes active

  • subtract_remaining_root_motion (bool): [Read-Write] Should root motion after this notify state be subtracted from warp target transform.

    This means actor will arrive at warp target transform when the animation finishes, not when the notify ends

  • total_root_motion_within_window (Transform): [Read-Write] Total root motion within the warping window

  • warp_max_rotation_rate (float): [Read-Write] Maximum rotation rate in degrees/sec. Will be the value used in constant rotation rate

  • warp_point_anim_bone_name (Name): [Read-Write] TODO:: Hide from the UI when Target != Bone

  • warp_point_anim_provider (WarpPointAnimProvider): [Read-Write]

  • warp_point_anim_transform (Transform): [Read-Write] TODO:: Hide from the UI when Target != Static

  • warp_rotation (bool): [Read-Write] Whether to warp the rotation component of the root motion

  • warp_rotation_time_multiplier (float): [Read-Write] Allow to modify how fast the rotation is warped. e.g if the window duration is 2sec and this is 0.5, the target rotation will be reached in 1sec instead of 2sec

  • warp_target_name (Name): [Read-Write] Name used to find the warp target for this modifier

  • warp_to_feet_location (bool): [Read-Write] Whether we warp the actors location or their foot location to the warp target

  • warp_translation (bool): [Read-Write] Whether to warp the translation component of the root motion

  • weight (float): [Read-Write] Current blend weight of the animation

property add_translation_easing_curve: CurveFloat

[Read-Write] Custom curve used to add translation when there is none to warp. Only relevant when AddTranslationEasingFunc is set to Custom

Type:

(CurveFloat)

property add_translation_easing_func: AlphaBlendOption

[Read-Write] Easing function used when adding translation. Only relevant when there is no translation in the animation

Type:

(AlphaBlendOption)

property ignore_z_axis: bool

[Read-Write] Whether to ignore the Z component of the translation. Z motion will remain untouched

Type:

(bool)

property rotation_method: MotionWarpRotationMethod

[Read-Write] The method of rotation to use

Type:

(MotionWarpRotationMethod)

property rotation_type: MotionWarpRotationType

[Read-Write] Whether rotation should be warp to match the rotation of the sync point or to face the sync point

Type:

(MotionWarpRotationType)

property subtract_remaining_root_motion: bool

[Read-Write] Should root motion after this notify state be subtracted from warp target transform. This means actor will arrive at warp target transform when the animation finishes, not when the notify ends

Type:

(bool)

property warp_max_rotation_rate: float

[Read-Write] Maximum rotation rate in degrees/sec. Will be the value used in constant rotation rate

Type:

(float)

property warp_point_anim_bone_name: Name

[Read-Write] TODO:: Hide from the UI when Target != Bone

Type:

(Name)

property warp_point_anim_provider: WarpPointAnimProvider

[Read-Write]

Type:

(WarpPointAnimProvider)

property warp_point_anim_transform: Transform

[Read-Write] TODO:: Hide from the UI when Target != Static

Type:

(Transform)

property warp_rotation: bool

[Read-Write] Whether to warp the rotation component of the root motion

Type:

(bool)

property warp_rotation_time_multiplier: float

[Read-Write] Allow to modify how fast the rotation is warped. e.g if the window duration is 2sec and this is 0.5, the target rotation will be reached in 1sec instead of 2sec

Type:

(float)

property warp_target_name: Name

[Read-Write] Name used to find the warp target for this modifier

Type:

(Name)

property warp_to_feet_location: bool

[Read-Write] Whether we warp the actors location or their foot location to the warp target

Type:

(bool)

property warp_translation: bool

[Read-Write] Whether to warp the translation component of the root motion

Type:

(bool)