1. Epic GamesDeveloper
  3. UVCamUIFunctionLibrary

UVCamUIFunctionLibrary

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

API > API/Plugins > API/Plugins/VCamCore

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

   
Name UVCamUIFunctionLibrary
Type class
Header File /Engine/Plugins/VirtualProduction/VirtualCameraCore/Source/VCamCore/Public/UI/VCamUIFunctionLibrary.h
Include Path #include "UI/VCamUIFunctionLibrary.h"

Syntax

UCLASS ()  
class UVCamUIFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static UInputAction * GetConnectedInputAction_VCamConnection ( const FVCamConnection& Connection
)

 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 UI/VCamUIFunctionLibrary.h
  • BlueprintPure
  • Category="VCam Connections"
  • Meta=(DisplayName="Get Connected Input Action")

static bool GetConnectedInputAction_VCamWidget ( UVCamWidget* Widget,
FName ConnectionId,
UInputAction*& OutInputAction
)

 Gets the input action mapped to ConnectionId on the widget. UI/VCamUIFunctionLibrary.h  

static UVCamModifier * GetConnectedModifier_VCamConnection ( const FVCamConnection& Connection
)

 Gets the Connected Modifier for the given VCam Connection The returned Modifier is guaranteed to be valid if IsConnected() is true UI/VCamUIFunctionLibrary.h
  • BlueprintPure
  • Category="VCam Connections"
  • Meta=(DisplayName="Get Connected Modifier")

static bool GetConnectedModifier_VCamWidget ( UVCamWidget* Widget,
FName ConnectionId,
UVCamModifier*& OutModifier
)

 Gets the modifier connected to ConnectionId on the widget. UI/VCamUIFunctionLibrary.h
  • BlueprintPure
  • Category="VCam Connections"
  • Meta=(DisplayName="Get Connected Modifier By Name", DefaultToSelf="Widget")

static bool GetConnectionByName_VCamWidget ( UVCamWidget* Widget,
FName ConnectionId,
FVCamConnection& OutConnection
)

 Gets a connection by its ID. UI/VCamUIFunctionLibrary.h
  • BlueprintPure
  • Category="VCam Connections"
  • Meta=(DisplayName="Get Connection By Name", DefaultToSelf="Widget")
Gets the name of the associated Connection Point for a given VCam Connection. UI/VCamUIFunctionLibrary.h
  • BlueprintPure
  • Category="VCam Connections"
  • Meta=(DisplayName="Get Connection Point Name")

static bool GetConnectionPointName_VCamWidget ( UVCamWidget* Widget,
FName ConnectionId,
FName& OutConnectionPointName
)

 Gets the connection point the connection ConnectionId attempts to connect to on the widget. UI/VCamUIFunctionLibrary.h
  • BlueprintPure
  • Category="VCam Connections"
  • Meta=(DisplayName="Get Connection Point Name By Name", DefaultToSelf="Widget")

static bool IsConnected_VCamConnection ( const FVCamConnection& Connection
)

 Checks whether a given VCam Connection is successfully connected. UI/VCamUIFunctionLibrary.h
  • BlueprintPure
  • Category="VCam Connections"
  • Meta=(DisplayName="Is Connected")

static bool IsConnected_VCamWidget ( UVCamWidget* Widget,
FName ConnectionId,
bool& bOutIsConnected
)

 Gets whether the ConnectionId is connected on the widget. UI/VCamUIFunctionLibrary.h
  • BlueprintPure
  • Category="VCam Connections"
  • Meta=(DisplayName="Is Connected By Name", DefaultToSelf="Widget")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page