unreal.BaseMovementModeTransition

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

Bases: Object

Base class for all transitions

C++ Source:

• Plugin: Mover

• Module: Mover

• File: MovementModeTransition.h

Editor Properties: (see get_editor_property/set_editor_property)

• allow_mode_reentry (bool): [Read-Write] Whether this transition should reenter a mode if it evaluates true and wants to transition into a mode the actor is already in

• first_sub_step_only (bool): [Read-Write] Whether this transition should only apply to the first step of the update. If true, modes reached after transitions or mode changes in the current update will not consider this transition

• shared_settings_classes (Array[type(Class)]): [Read-Write] Settings object type that this mode depends on. May be shared with other transitions and movement modes. When the transition 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 transition supports being part of an asynchronous movement simulation (running concurrently with the gameplay thread) Specifically for the Evaluate and Trigger functions

property allow_mode_reentry: bool

[Read-Write] Whether this transition should reenter a mode if it evaluates true and wants to transition into a mode the actor is already in

Type:

(bool)

evaluate(params) → TransitionEvalResult

Evaluate

Parameters:

params (SimulationTickParams)

Return type:

TransitionEvalResult

property first_sub_step_only: bool

[Read-Write] Whether this transition should only apply to the first step of the update. If true, modes reached after transitions or mode changes in the current update will not consider this transition

Type:

(bool)

get_mover_component() → MoverComponent

deprecated: ‘get_mover_component’ was renamed to ‘k2_get_mover_component’.

k2_get_mover_component() → MoverComponent

Gets the MoverComponent that ultimately owns this transition

Return type:

MoverComponent

k2_on_evaluate(params: SimulationTickParams) → TransitionEvalResult

deprecated: ‘k2_on_evaluate’ was renamed to ‘evaluate’.

k2_on_trigger(params: SimulationTickParams) → None

deprecated: ‘k2_on_trigger’ was renamed to ‘trigger’.

on_registered() → None

K2 on Registered

on_unregistered() → None

K2 on Unregistered

property supports_async: bool

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

Type:

(bool)

trigger(params) → None

Trigger

Parameters:

params (SimulationTickParams)