unreal.MovementSettings

class unreal.MovementSettings(minimum_step_length: float = 0.0, speed_max: float = 0.0, speed_min: float = 0.0, phase_speed_max: float = 0.0, phase_speed_min: float = 0.0, acceleration: float = 0.0, deceleration: float = 0.0, global_time_scale: float = 0.0, teleport: bool = False, styles: None = [])

Bases: StructBase

Movement Settings

C++ Source:

  • Plugin: Locomotor

  • Module: Locomotor

  • File: RigUnit_Locomotor.h

Editor Properties: (see get_editor_property/set_editor_property)

  • acceleration (float): [Read-Write] the acceleration in cm/s/s (ie, how quickly the movement speed increases to reach the goal)

  • deceleration (float): [Read-Write] the acceleration in cm/s/s (ie, how quickly the movement speed decreases when approaching the goal)

  • global_time_scale (float): [Read-Write] adjust global speed of the simulation

  • minimum_step_length (float): [Read-Write] the length of the smallest step to take in cm

  • phase_speed_max (float): [Read-Write] the maximum phase speed in cycles/s

  • phase_speed_min (float): [Read-Write] the minimum phase speed in cycles/s

  • speed_max (float): [Read-Write] the maximum movement speed in cm/s

  • speed_min (float): [Read-Write] the minimum movement speed in cm/s

  • styles (Array[LocomotorMovementStyle]): [Read-Write] The the movement styles to cycle through based on speed

  • teleport (bool): [Read-Write] reset the simulation. this can be used to teleport the locomotor.

property acceleration: float

[Read-Write] the acceleration in cm/s/s (ie, how quickly the movement speed increases to reach the goal)

Type:

(float)

property deceleration: float

[Read-Write] the acceleration in cm/s/s (ie, how quickly the movement speed decreases when approaching the goal)

Type:

(float)

property global_time_scale: float

[Read-Write] adjust global speed of the simulation

Type:

(float)

property minimum_step_length: float

[Read-Write] the length of the smallest step to take in cm

Type:

(float)

property phase_speed_max: float

[Read-Write] the maximum phase speed in cycles/s

Type:

(float)

property phase_speed_min: float

[Read-Write] the minimum phase speed in cycles/s

Type:

(float)

property speed_max: float

[Read-Write] the maximum movement speed in cm/s

Type:

(float)

property speed_min: float

[Read-Write] the minimum movement speed in cm/s

Type:

(float)

property styles: None

[Read-Write] The the movement styles to cycle through based on speed

Type:

(Array[LocomotorMovementStyle])

property teleport: bool

[Read-Write] reset the simulation. this can be used to teleport the locomotor.

Type:

(bool)