unreal.VCamConnection

class unreal.VCamConnection(required_interfaces: None = [], optional_interfaces: None = [], requires_input_action: bool = False, action_type: InputActionValueType = Ellipsis, manually_configure_connection: bool = False, connection_target_settings: VCamConnectionTargetSettings = Ellipsis)

Bases: StructBase

  • A VCam Connection allows an external object (primarily widgets) to communicate with VCam Modifiers through Connection Points that have known properties.

  • The connection allows you to specify a set of requirements that a connection point on a modifier must implement

  • for it to be considered a valid thing to connect to and then a function “AttemptConnection” that will try to resolve

  • a given VCam Component to a specific Modifier along with an optional associated Input Action

C++ Source:

  • Plugin: VirtualCameraCore

  • Module: VCamCore

  • File: VCamConnectionStructs.h

Editor Properties: (see get_editor_property/set_editor_property)

  • action_type (InputActionValueType): [Read-Write] * If this connection requires an Input Action then this property specifies what Input Action Type the Connection Point must provide to be considered a valid connection

  • connection_target_settings (VCamConnectionTargetSettings): [Read-Write] * A struct containing information about which Modifier and Connection Point to look for when attempting a connection

  • manually_configure_connection (bool): [Read-Write] * If you are not using an external system to configure the connection then you can enable this to have * explicit control over which Modifier and Connection Point to look for when attempting a connection

  • optional_interfaces (Array[type(Class)]): [Read-Write] * A list of interfaces that a modifier may optionally implement that this connection can use * * These interfaces are not tested for when attempting a connection but are stored so that * a Configurator system can provide extra information a user when they are configuring connections

  • required_interfaces (Array[type(Class)]): [Read-Write] * A list of interfaces that a modifier must implement to be considered a valid connection

  • requires_input_action (bool): [Read-Write] * Whether this connection requires a target Connection Point to have an associated Input Action to be considered a valid connection

property action_type: InputActionValueType

[Read-Write] * If this connection requires an Input Action then this property specifies what Input Action Type the Connection Point must provide to be considered a valid connection

Type:

(InputActionValueType)

property connection_target_settings: VCamConnectionTargetSettings

[Read-Write] * A struct containing information about which Modifier and Connection Point to look for when attempting a connection

Type:

(VCamConnectionTargetSettings)

property manually_configure_connection: bool

[Read-Write] * If you are not using an external system to configure the connection then you can enable this to have * explicit control over which Modifier and Connection Point to look for when attempting a connection

Type:

(bool)

property optional_interfaces: None

[Read-Write] * A list of interfaces that a modifier may optionally implement that this connection can use * * These interfaces are not tested for when attempting a connection but are stored so that * a Configurator system can provide extra information a user when they are configuring connections

Type:

(Array[type(Class)])

property required_interfaces: None

[Read-Write] * A list of interfaces that a modifier must implement to be considered a valid connection

Type:

(Array[type(Class)])

property requires_input_action: bool

[Read-Write] * Whether this connection requires a target Connection Point to have an associated Input Action to be considered a valid connection

Type:

(bool)