unreal.BaseMovementMode

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

Bases: Object

Base class for all movement modes, exposing simulation update methods for both C++ and blueprint extension

C++ Source:

  • Plugin: Mover

  • Module: Mover

  • File: MovementMode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • gameplay_tags (GameplayTagContainer): [Read-Write] A list of gameplay tags associated with this movement mode

  • shared_settings_classes (Array[type(Class)]): [Read-Write] Settings object type that this mode depends on. May be shared with other movement modes. When the mode is added to a Mover Component, it will create a shared instance of this settings class.

  • supports_async (bool): [Read-Write] Whether this movement mode supports being part of an asynchronous movement simulation (running concurrently with the gameplay thread) Specifically for the GenerateMove and SimulationTick functions

  • transitions (Array[BaseMovementModeTransition]): [Read-Write] Transition checks for the current mode. Evaluated in order, stopping at the first successful transition check

generate_move(start_state, time_step, out_proposed_move) → ProposedMove

Generate Move

Parameters:
Returns:

out_proposed_move (ProposedMove):

Return type:

ProposedMove

get_mover_component() → MoverComponent

Gets the MoverComponent that owns this movement mode

Return type:

MoverComponent

k2_on_generate_move(start_state: MoverTickStartData, time_step: MoverTimeStep, out_proposed_move: ProposedMove) → ProposedMove

deprecated: ‘k2_on_generate_move’ was renamed to ‘generate_move’.

k2_on_simulation_tick(params: SimulationTickParams, output_state: MoverTickEndData) → MoverTickEndData

deprecated: ‘k2_on_simulation_tick’ was renamed to ‘simulation_tick’.

on_activated() → None

K2 on Activated

on_deactivated() → None

K2 on Deactivated

on_registered(mode_name) → None

K2 on Registered

Parameters:

mode_name (Name)

on_unregistered() → None

K2 on Unregistered

simulation_tick(params, output_state) → MoverTickEndData

Simulation Tick

Parameters:
Returns:

output_state (MoverTickEndData):

Return type:

MoverTickEndData

property supports_async: bool

[Read-Only] Whether this movement mode supports being part of an asynchronous movement simulation (running concurrently with the gameplay thread) Specifically for the GenerateMove and SimulationTick functions

Type:

(bool)

property transitions: None

[Read-Only] Transition checks for the current mode. Evaluated in order, stopping at the first successful transition check

Type:

(Array[BaseMovementModeTransition])