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)

  • shared_settings_class (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.

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

get_blackboard() → MoverBlackboard

Get Blackboard

Return type:

MoverBlackboard

get_blackboard_mutable() → MoverBlackboard

Get Blackboard Mutable

Return type:

MoverBlackboard

get_mover_component() → MoverComponent

Get Mover Component

Return type:

MoverComponent

on_generate_move(start_state, time_step) → ProposedMove

K2 on Generate Move

Parameters:
Return type:

ProposedMove

on_registered(mode_name) → None

K2 on Registered

Parameters:

mode_name (Name) –

on_simulation_tick(params) → MoverTickEndData

K2 on Simulation Tick

Parameters:

params (SimulationTickParams) –

Return type:

MoverTickEndData

on_unregistered() → None

K2 on Unregistered

property transitions: None

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

Type:

(Array[BaseMovementModeTransition])