unreal.MotionTrajectoryComponent

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

Bases: ActorComponent

Abstract component interface for the minimum Motion Trajectory prediction and history API

C++ Source:

  • Plugin: MotionTrajectory

  • Module: MotionTrajectory

  • File: MotionTrajectory.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Whether this component can potentially influence navigation

  • component_tags (Array[Name]): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • debug_draw_trajectory (bool): [Read-Write] Debug drawing options for the complete trajectory range a.MotionTrajectory.Debug (0/1) to enable or disable a.MotionTrajectory.Options (0-6) to enable additional sample information a.MotionTrajectory.Stride (*) to stride sample information display by a specified modulo

  • editable_when_inherited (bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor class

  • history_settings (MotionTrajectorySettings): [Read-Write] Historical trajectory settings

  • is_editor_only (bool): [Read-Write] If true, the component will be excluded from non-editor builds

  • max_samples (int32): [Read-Write] The maximum number of trajectory samples retained by the internal history buffer

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivated

  • prediction_includes_history (bool): [Read-Write] Determines if GetTrajectory() will automatically combine history into the returned trajectory prediction (true) Consider disabling this option when historical trajectory samples are never used Example: No Motion Matching historical sample times or distances are defined in the Pose Search Schema

  • prediction_settings (MotionTrajectorySettings): [Read-Write] Prediction trajectory simulation settings

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Main tick function for the Component

  • replicate_using_registered_sub_object_list (bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

  • replicates (bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • sample_rate (int32): [Read-Write] The trajectory sampling rate for prediction

get_history() → TrajectorySampleRange

Retrieves the historical trajectory

Return type:

TrajectorySampleRange

get_trajectory() → TrajectorySampleRange

Interface for computing a trajectory prediction

Return type:

TrajectorySampleRange

get_trajectory_with_settings(settings, include_history) → TrajectorySampleRange

Interface for computing a trajectory prediction with overridden component settings

Parameters:
Return type:

TrajectorySampleRange

property history_settings: MotionTrajectorySettings

[Read-Only] Historical trajectory settings

Type:

(MotionTrajectorySettings)

property max_samples: int

[Read-Only] The maximum number of trajectory samples retained by the internal history buffer

Type:

(int32)

property prediction_includes_history: bool

[Read-Only] Determines if GetTrajectory() will automatically combine history into the returned trajectory prediction (true) Consider disabling this option when historical trajectory samples are never used Example: No Motion Matching historical sample times or distances are defined in the Pose Search Schema

Type:

(bool)

property prediction_settings: MotionTrajectorySettings

[Read-Only] Prediction trajectory simulation settings

Type:

(MotionTrajectorySettings)

property sample_rate: int

[Read-Only] The trajectory sampling rate for prediction

Type:

(int32)