unreal.StepSettings

class unreal.StepSettings(percent_of_stride_in_air: float = 0.0, air_extension_at_max_speed: float = 0.0, step_height: float = 0.0, step_ease_in: float = 0.0, step_ease_out: float = 0.0, enable_foot_collision: bool = False, foot_collision_global_scale: float = 0.0, enable_ground_collision: bool = False, max_collision_height: float = 0.0, trace_channel: TraceTypeQuery = Ellipsis, orient_foot_to_ground_pitch: float = 0.0, orient_foot_to_ground_roll: float = 0.0)

Bases: StructBase

Step Settings

C++ Source:

• Plugin: Locomotor

• Module: Locomotor

• File: RigUnit_Locomotor.h

Editor Properties: (see get_editor_property/set_editor_property)

• air_extension_at_max_speed (float): [Read-Write] Default is 0.2. Range is 0.0 - 0.9. This value is added to the “PercentOfStrideInAir” to extend the air-time while at max speed. For example, if PercentOfStrideInAir is at 0.5, and the air extension is at 0.4 the foot will be in the air for 90% of the stride cycle. This value is gradually blended on as the Speed accelerates between SpeedMin and SpeedMax. The total “Stride In Air” is clamped internally at 95%

• enable_foot_collision (bool): [Read-Write] Default is true. When true, feet are treated as non-overlapping circles and will not overlap each other or cross over.

• enable_ground_collision (bool): [Read-Write] Default is true. When true, foot height is adjusted using sphere-casting against the world.

• foot_collision_global_scale (float): [Read-Write] Default is 1.0. Range is 0-inf. Global scale multiplier for all foot collision radii.

• max_collision_height (float): [Read-Write] Default is 30. Range is 0-inf. The maximum height in cm to place foot on-top of collision geo (may move foot up or down by this amount).

• orient_foot_to_ground_pitch (float): [Read-Write] Default is 0.8. Range is 0-1. When Ground Collision is enabled, this will orient the pitch of the foot to match the slope of the ground.

• orient_foot_to_ground_roll (float): [Read-Write] Default is 0.8. Range is 0-1. When Ground Collision is enabled, this will orient the roll of the foot to match the slope of the ground.

• percent_of_stride_in_air (float): [Read-Write] Default is 0.35. Range is 0.1 - 0.9. The percentage amount of the 0-1 stride phase where the foot is in the air. At the default (0.35), the foot will plant on the ground 35% through it’s total phase. At lower values, the foot will spend more time on the ground as a percentage of the total stride time. At higher values, each foot will spend less time on the ground as a percentage of the total stride time.

• step_ease_in (float): [Read-Write] Default is 0.5. Range is 0-1. How quickly the foot accelerates when lifting off the ground. At 0, it instantly moves, at 1 it eases in.

• step_ease_out (float): [Read-Write] Default is 0.2. Range is 0-1. How quickly the foot decelerates when planting. At 0, it instantly stops on contact, at 1 it eases into contact.

• step_height (float): [Read-Write] Default is 6. Range is 0-inf. The height to raise foot (in cm) at the peak of the largest stride

• trace_channel (TraceTypeQuery): [Read-Write] The ‘channel’ used to trace spheres into the physics world for collision detection. Determines which components to hit.

property air_extension_at_max_speed: float

[Read-Write] Default is 0.2. Range is 0.0 - 0.9. This value is added to the “PercentOfStrideInAir” to extend the air-time while at max speed. For example, if PercentOfStrideInAir is at 0.5, and the air extension is at 0.4 the foot will be in the air for 90% of the stride cycle. This value is gradually blended on as the Speed accelerates between SpeedMin and SpeedMax. The total “Stride In Air” is clamped internally at 95%

Type:

(float)

property enable_foot_collision: bool

[Read-Write] Default is true. When true, feet are treated as non-overlapping circles and will not overlap each other or cross over.

Type:

(bool)

property enable_ground_collision: bool

[Read-Write] Default is true. When true, foot height is adjusted using sphere-casting against the world.

Type:

(bool)

property foot_collision_global_scale: float

[Read-Write] Default is 1.0. Range is 0-inf. Global scale multiplier for all foot collision radii.

Type:

(float)

property max_collision_height: float

[Read-Write] Default is 30. Range is 0-inf. The maximum height in cm to place foot on-top of collision geo (may move foot up or down by this amount).

Type:

(float)

property orient_foot_to_ground_pitch: float

[Read-Write] Default is 0.8. Range is 0-1. When Ground Collision is enabled, this will orient the pitch of the foot to match the slope of the ground.

Type:

(float)

property orient_foot_to_ground_roll: float

[Read-Write] Default is 0.8. Range is 0-1. When Ground Collision is enabled, this will orient the roll of the foot to match the slope of the ground.

Type:

(float)

property percent_of_stride_in_air: float

[Read-Write] Default is 0.35. Range is 0.1 - 0.9. The percentage amount of the 0-1 stride phase where the foot is in the air. At the default (0.35), the foot will plant on the ground 35% through it’s total phase. At lower values, the foot will spend more time on the ground as a percentage of the total stride time. At higher values, each foot will spend less time on the ground as a percentage of the total stride time.

Type:

(float)

property step_ease_in: float

[Read-Write] Default is 0.5. Range is 0-1. How quickly the foot accelerates when lifting off the ground. At 0, it instantly moves, at 1 it eases in.

Type:

(float)

property step_ease_out: float

[Read-Write] Default is 0.2. Range is 0-1. How quickly the foot decelerates when planting. At 0, it instantly stops on contact, at 1 it eases into contact.

Type:

(float)

property step_height: float

[Read-Write] Default is 6. Range is 0-inf. The height to raise foot (in cm) at the peak of the largest stride

Type:

(float)

property trace_channel: TraceTypeQuery

[Read-Write] The ‘channel’ used to trace spheres into the physics world for collision detection. Determines which components to hit.

Type:

(TraceTypeQuery)