unreal.MoverAnimMontageState

class unreal.MoverAnimMontageState(montage: AnimMontage = Ellipsis, starting_montage_position: float = 0.0, play_rate: float = 0.0, current_position: float = 0.0, blend_out_time_seconds: float = 0.0, enable_auto_blend_out: bool = False)

Bases: StructBase

Data about montages that is replicated to simulated clients

C++ Source:

  • Plugin: Mover

  • Module: Mover

  • File: MontageStateProvider.h

Editor Properties: (see get_editor_property/set_editor_property)

  • blend_out_time_seconds (float): [Read-Write] Duration of the blend-out in seconds, copied from the montage asset’s default blend-out at move-creation time. Used by the PT to compute the blend-out trigger position.

  • current_position (float): [Read-Write] Current position (during playback only)

  • debug_montage_name (Name): [Read-Only] Asset name of Montage, kept in sync with the Montage pointer for CVD display (UObject references cannot cross the CVD trace boundary). Not net serialized – derived locally from the Montage pointer on each machine. Only populated in non-shipping builds.

  • enable_auto_blend_out (bool): [Read-Write] True when the simulation should automatically trigger blend-out based on playback position approaching the end of the montage. Set to false for montages that require an external stop signal (e.g. internally looping montages whose terminal section is reached via JumpToSection on the GT); for those, blend-out falls back to DurationMs expiry.

  • montage (AnimMontage): [Read-Write]

  • play_rate (float): [Read-Write] Rate at which this montage is intended to play

  • starting_montage_position (float): [Read-Write] Montage position when started (in unscaled seconds).

property blend_out_time_seconds: float

[Read-Only] Duration of the blend-out in seconds, copied from the montage asset’s default blend-out at move-creation time. Used by the PT to compute the blend-out trigger position.

Type:

(float)

property current_position: float

[Read-Only] Current position (during playback only)

Type:

(float)

property enable_auto_blend_out: bool

[Read-Only] True when the simulation should automatically trigger blend-out based on playback position approaching the end of the montage. Set to false for montages that require an external stop signal (e.g. internally looping montages whose terminal section is reached via JumpToSection on the GT); for those, blend-out falls back to DurationMs expiry.

Type:

(bool)

property montage: AnimMontage

[Read-Write]

Type:

(AnimMontage)

property play_rate: float

[Read-Write] Rate at which this montage is intended to play

Type:

(float)

property starting_montage_position: float

[Read-Write] Montage position when started (in unscaled seconds).

Type:

(float)