unreal.LiveLinkComponentController

class unreal.LiveLinkComponentController(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: ActorComponent

Live Link Component Controller

C++ Source:

  • Plugin: LiveLink

  • Module: LiveLinkComponents

  • File: LiveLinkComponentController.h

Editor Properties: (see get_editor_property/set_editor_property)

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

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

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

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

  • controller_map (Map[type(Class), LiveLinkControllerBase]): [Read-Write] Controller Map: Instanced controllers used to control the desired role

  • disable_evaluate_live_link_when_spawnable (bool): [Read-Write] Disable Evaluate Live Link when Spawnable: If true, will not evaluate LiveLink if the attached actor is a spawnable in Sequencer

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

  • evaluate_live_link (bool): [Read-Write] Evaluate Live Link: If false, will not evaluate live link, effectively pausing.

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

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

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

  • on_controller_map_updated_delegate (OnControllerMapUpdatedDelegate): [Read-Write] On Controller Map Updated Delegate: This Event is triggered any time the controller map is updated

  • on_live_link_updated (LiveLinkTickDelegate): [Read-Write] On Live Link Updated: This Event is triggered any time new LiveLink data is available, including in the editor

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

  • replicate_using_registered_sub_object_list (bool): [Read-Write] Replicate Using Registered Sub Object List: 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] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

  • subject_representation (LiveLinkSubjectRepresentation): [Read-Write] Subject Representation

  • update_in_editor (bool): [Read-Write] Update in Editor

  • update_in_preview_editor (bool): [Read-Write] Update in Preview Editor: If true, will tick when the world is a preview (i.e Blueprint editors)

property controller_map: Map[Class, LiveLinkControllerBase]

[Read-Only] Controller Map: Instanced controllers used to control the desired role

Type:

(Map[type(Class), LiveLinkControllerBase])

[Read-Write] Disable Evaluate Live Link when Spawnable: If true, will not evaluate LiveLink if the attached actor is a spawnable in Sequencer

Type:

(bool)

[Read-Write] Evaluate Live Link: If false, will not evaluate live link, effectively pausing.

Type:

(bool)

property on_controller_map_updated_delegate: OnControllerMapUpdatedDelegate

[Read-Write] On Controller Map Updated Delegate: This Event is triggered any time the controller map is updated

Type:

(OnControllerMapUpdatedDelegate)

[Read-Write] On Live Link Updated: This Event is triggered any time new LiveLink data is available, including in the editor

Type:

(LiveLinkTickDelegate)

property subject_representation: LiveLinkSubjectRepresentation

[Read-Write] Subject Representation

Type:

(LiveLinkSubjectRepresentation)