unreal.ParametricMovementComponent

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

Bases: BaseMovementComponent

ActorComponent for running basic Parametric movement. Parametric movement could be anything that takes a Time and returns an FTransform.

Initially, we will support pushing (ie, we sweep as we update the mover’s position). But we will not allow a parametric mover from being blocked.

C++ Source:

  • Plugin: NetworkPredictionExtras

  • Module: NetworkPredictionExtras

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

  • disable_parametric_movement_simulation (bool): [Read-Write] Disables starting the simulation. For development/testing ease of use

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

  • enable_dependent_simulation (bool): [Read-Write]

  • enable_force_net_update (bool): [Read-Write] Calls ForceNetUpdate every frame. Has slightly different behavior than a very high NetUpdateFrequency

  • enable_interpolation (bool): [Read-Write]

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

  • 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

  • parametric_motion (SimpleParametricMotion): [Read-Write]

  • parent_net_update_frequency (float): [Read-Write] Sets NetUpdateFrequency on parent. This is editable on the component and really just meant for use during development/test maps

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

property disable_parametric_movement_simulation: bool

[Read-Only] Disables starting the simulation. For development/testing ease of use

Type:

(bool)

property enable_dependent_simulation: bool

[Read-Only]

Type:

(bool)

property enable_force_net_update: bool

[Read-Only] Calls ForceNetUpdate every frame. Has slightly different behavior than a very high NetUpdateFrequency

Type:

(bool)

property enable_interpolation: bool

[Read-Only]

Type:

(bool)

enable_interpolation_mode(value) → None

Enable Interpolation Mode

Parameters:

value (bool) –

property parametric_motion: SimpleParametricMotion

[Read-Write]

Type:

(SimpleParametricMotion)

property parent_net_update_frequency: float

[Read-Only] Sets NetUpdateFrequency on parent. This is editable on the component and really just meant for use during development/test maps

Type:

(float)