unreal.MoverDebugComponent

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

Bases: ActorComponent

Component to help display debug information for actors using the Mover Component. Is expected to be attached to the actor that has the mover component. Currently supports trajectory functionality and trailing functionality. Is also used in the gameplay debugger under the mover category.

C++ Source:

  • Plugin: Mover

  • Module: Mover

  • File: MoverDebugComponent.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

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

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

  • history_samples_per_second (int32): [Read-Write] Target sampling rate for history tracking. Note that sampling rate is variable and may be higher during times of rapid change. see: SetHistoryTracking

  • history_tracking_seconds (float): [Read-Write] Begin Motion history tracking Max age of tracked samples. Feature is disabled for values <= 0. see: SetHistoryTracking

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

  • lookahead_samples_per_second (int32): [Read-Write] Number of times trajectory will be sampled each second

  • lookahead_seconds (float): [Read-Write] Number of seconds to lookahead and show the current trajectory

  • 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

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

  • show_corrections (bool): [Read-Write] Whether this component should show the corrections and rollbacks applied to the Actor it’s attached too

  • show_trail (bool): [Read-Write] Whether this component should show the trail of the movement component of the Actor it’s attached too

  • show_trajectory (bool): [Read-Write] Whether this component should show the trajectory of the movement component of the Actor it’s attached too

get_past_trajectory() → Array[TrajectorySampleInfo]

Get a read-only sampling of where the actor has recently been, ordered by ascending age. Will be empty unless history tracking is enabled. see: SetHistoryTracking

Return type:

Array[TrajectorySampleInfo]

property history_samples_per_second: int

[Read-Only] Target sampling rate for history tracking. Note that sampling rate is variable and may be higher during times of rapid change. see: SetHistoryTracking

Type:

(int32)

property history_tracking_seconds: float

[Read-Only] Begin Motion history tracking Max age of tracked samples. Feature is disabled for values <= 0. see: SetHistoryTracking

Type:

(float)

property lookahead_samples_per_second: int

[Read-Write] Number of times trajectory will be sampled each second

Type:

(int32)

property lookahead_seconds: float

[Read-Write] Number of seconds to lookahead and show the current trajectory

Type:

(float)

set_history_tracking(seconds_to_track, samples_per_second) → None

Change history tracking feature settings. Anything <= 0 for SecondsToTrack will disable the feature.

Parameters:

  • seconds_to_track (float) –

  • samples_per_second (float) –

property show_corrections: bool

[Read-Write] Whether this component should show the corrections and rollbacks applied to the Actor it’s attached too

Type:

(bool)

property show_trail: bool

[Read-Write] Whether this component should show the trail of the movement component of the Actor it’s attached too

Type:

(bool)

property show_trajectory: bool

[Read-Write] Whether this component should show the trajectory of the movement component of the Actor it’s attached too

Type:

(bool)