unreal.FollowPathMode

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

Bases: BaseMovementMode

FollowPathMode: This mode performs simple movement of the associated actor, attempting to interpolate through a series of locations. There are variety of settings that affect behavior, such as speed and looping.

C++ Source:

  • Plugin: MoverExamples

  • Module: MoverExamples

  • File: FollowPathMode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • behaviour_type (InterpToBehaviourType): [Read-Write] Method of path-following

  • control_points (Array[InterpControlPoint]): [Read-Write] List of ordered path locations to visit

  • duration (float): [Read-Write] Time (in seconds) required to move from the first point to the last (or vice versa)

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

  • rotation_type (FollowPathRotationType): [Read-Write] Method of rotating the actor during path-following

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

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

property behaviour_type: InterpToBehaviourType

[Read-Write] Method of path-following

Type:

(InterpToBehaviourType)

property control_points: None

[Read-Write] List of ordered path locations to visit

Type:

(Array[InterpControlPoint])

property duration: float

[Read-Write] Time (in seconds) required to move from the first point to the last (or vice versa)

Type:

(float)

on_generate_move(start_state, time_step) → ProposedMove

On Generate Move

Parameters:
Returns:

out_proposed_move (ProposedMove):

Return type:

ProposedMove

on_simulation_tick(params) → MoverTickEndData

On Simulation Tick

Parameters:

params (SimulationTickParams)

Returns:

output_state (MoverTickEndData):

Return type:

MoverTickEndData

property rotation_type: FollowPathRotationType

[Read-Write] Method of rotating the actor during path-following

Type:

(FollowPathRotationType)