unreal.MovementModifierBase

class unreal.MovementModifierBase(duration_ms: float = 0.0, start_sim_time_ms: float = 0.0)

Bases: StructBase

Movement Modifier: Used to apply changes that indirectly influence the movement simulation, without proposing or executing any movement, but still in sync with the sim. Example usages: changing groups of settings, movement mode re-mappings, etc.

Note: Currently mover expects to only have one type of modifier active at a time.

This can be fixed by extending the Matches function to check more than just type, but make sure anything used to compare is synced through the NetSerialize function.

C++ Source:

  • Plugin: Mover

  • Module: Mover

  • File: MovementModifier.h

Editor Properties: (see get_editor_property/set_editor_property)

  • duration_ms (float): [Read-Write] This modifier will expire after a set amount of time if > 0. If 0, it will be ticked only once, regardless of time step. It will need to be manually ended if < 0.

  • start_sim_time_ms (double): [Read-Only] The simulation time this move first ticked (< 0 means it hasn’t started yet)

property duration_ms: float

[Read-Write] This modifier will expire after a set amount of time if > 0. If 0, it will be ticked only once, regardless of time step. It will need to be manually ended if < 0.

Type:

(float)

property start_sim_time_ms: float

[Read-Only] The simulation time this move first ticked (< 0 means it hasn’t started yet)

Type:

(double)