unreal.VCamUIFunctionLibrary

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

Bases: BlueprintFunctionLibrary

Function Library primarily used for exposing functionality of UI related structs to Blueprints

C++ Source:

  • Plugin: VirtualCameraCore

  • Module: VCamCore

  • File: VCamUIFunctionLibrary.h

classmethod get_connected_input_action_v_cam_connection(connection) → InputAction

Gets the Connected Input Action for the given VCam Connection The returned Input Action is only guaranteed to be valid if both IsConnected() is true AND the VCam Connection is set to require an Input Action If the VCam Connection doesn’t require an Input Action then this may still return a valid Action if the Connection Point had an associated Input Action however you will need to test for this manually

Parameters:

connection (VCamConnection)

Return type:

InputAction

classmethod get_connected_input_action_v_cam_widget(widget, connection_id) → InputAction or None

Gets the input action mapped to ConnectionId on the widget.

Parameters:
Returns:

out_input_action (InputAction):

Return type:

InputAction or None

classmethod get_connected_modifier_v_cam_connection(connection) → VCamModifier

Gets the Connected Modifier for the given VCam Connection The returned Modifier is guaranteed to be valid if IsConnected() is true

Parameters:

connection (VCamConnection)

Return type:

VCamModifier

classmethod get_connected_modifier_v_cam_widget(widget, connection_id) → VCamModifier or None

Gets the modifier connected to ConnectionId on the widget.

Parameters:
Returns:

out_modifier (VCamModifier):

Return type:

VCamModifier or None

classmethod get_connection_by_name_v_cam_widget(widget, connection_id) → VCamConnection or None

Gets a connection by its ID.

Parameters:
Returns:

out_connection (VCamConnection):

Return type:

VCamConnection or None

classmethod get_connection_point_name_v_cam_connection(connection) → Name

Gets the name of the associated Connection Point for a given VCam Connection. This will return “None” if the IsConnected() is false

Parameters:

connection (VCamConnection)

Return type:

Name

classmethod get_connection_point_name_v_cam_widget(widget, connection_id) → Name or None

Gets the connection point the connection ConnectionId attempts to connect to on the widget.

Parameters:
Returns:

out_connection_point_name (Name):

Return type:

Name or None

classmethod is_connected_v_cam_connection(connection) → bool

Checks whether a given VCam Connection is successfully connected. If this returns true then it is safe to assume that the Connected Modifier for the Connection is valid to use

Parameters:

connection (VCamConnection)

Return type:

bool

classmethod is_connected_v_cam_widget(widget, connection_id) → bool or None

Gets whether the ConnectionId is connected on the widget.

Parameters:
Returns:

out_is_connected (bool):

Return type:

bool or None