1. Epic GamesDeveloper
  3. FVCamConnection

FVCamConnection

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

API > API/Plugins > API/Plugins/VCamCore > API/Plugins/VCamCore/UI

References

   
Module VCamCore
Header /Engine/Plugins/Experimental/VirtualCameraCore/Source/VCamCore/Public/UI/VCamConnectionStructs.h
Include #include "UI/VCamConnectionStructs.h"

Syntax

USTRUCT&40;BlueprintType&41;  
struct FVCamConnection

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EInputActionValueType ActionType 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
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bManuallyConfigureConnection 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
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bRequiresInputAction Whether this connection requires a target Connection Point to have an associated Input Action to be considered a valid connection
Public variable UProperty Transient TObjectPtr< UInputAction > ConnectedAction The Input Action that we are currently connected to
Public variable UProperty Transient TObjectPtr< UVCamModifier > ConnectedModifier The VCam Modifier that we are currently connected to
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FVCamConnectionTargetSettings ConnectionTargetSettings A struct containing information about which Modifier and Connection Point to look for when attempting a connection
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< TSubclassOf< UInterface > > OptionalInterfaces A list of interfaces that a modifier may optionally implement that this connection can use
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< TSubclassOf< UInterface > > RequiredInterfaces A list of interfaces that a modifier must implement to be considered a valid connection

Functions

  Type Name Description
Public function bool

AttemptConnection ( UVCamComponent* VCamComponent
)

 Attempts to make a connection to a target Connection Point and returns a bool indicating success
Public function Const bool Check whether this connection was successfully connected to a Connection Point
Public function Const bool

IsConnectionValid ( UVCamModifier& Modifier,
FName ConnectionPointName,
bool bLogWarnings
)

 Whether under the filter criteria of this struct it is legal to connection to ConnectionPoint from Modifier.
Public function void Clears any currently connected modifier and action

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page