1. Epic GamesDeveloper
  3. UPCGSwitchSettings

UPCGSwitchSettings

Routes data from the input pin, to a specific output pin based on a selection criteria (Int/String/Enum)

API > API/Plugins > API/Plugins/PCG > API/Plugins/PCG/Elements > API/Plugins/PCG/Elements/ControlFlow

Inheritance Hierarchy

References

   
Module PCG
Header /Engine/Plugins/PCG/Source/PCG/Public/Elements/ControlFlow/PCGSwitch.h
Include #include "Elements/ControlFlow/PCGSwitch.h"

Syntax

UCLASS (BlueprintType, ClassGroup=(Procedural), Meta=(Keywords="if multi enum branch"))  
class UPCGSwitchSettings : public UPCGSettings

Remarks

Routes data from the input pin, to a specific output pin based on a selection criteria (Int/String/Enum)

Variables

  Type Name Description
Public variable TArray< FName > CachedPinLabels Cached pin labels for use during the selection process.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FEnumSelector EnumSelection Determines which output pin will be selected if the selection mode is Enum.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 IntegerSelection Determines which output will be selected if the selection mode is Integer.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TArray< int32 > IntOptions Determines the available output pin selection options.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EPCGControlFlowSelectionMode SelectionMode Determines the type of value to be used to select an output.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TArray< FString > StringOptions Determines the available output pin selection options.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FString StringSelection Determines which output will be selected if the selection mode is String.

Functions

  Type Name Description
Public function void  
Public function Const int Returns the index of the currently selected pin.
Public function Const bool

GetSelectedPinLabel ( FName& OutSelectedPinLabel
)

 Helper function to use the appropriate selection value to determine the current selection.
Protected function Virtual Const bool Switch is dynamic if selection value is overridden / cannot be determined prior to execution.
Public function Const bool

IsValuePresent ( int32 Value
)

 Returns true if the integer value exists in the user defined options.
Public function Const bool

IsValuePresent ( const FString& Value
)

 Returns true if the string value exists in the user defined options.
Public function Const bool

IsValuePresent ( int64 Value
)

 Returns true if the enum value exists within the selected enum class.

Overridden from UPCGSettings

  Type Name Description
Protected function Virtual Const FPCGElementPtr  
Public function Virtual Const FString Derived classes can implement this to expose additional information or context, such as an asset in use by the node.
Protected function Virtual Const EPCGChangeType

GetChangeTypeForProperty ( const FName& InPropertyName
)

 Gets the change impact for a given property.
Public function Virtual Const FName  
Public function Virtual Const FText  
Public function Virtual Const FText  
Public function Virtual Const EPCGSettingsType

GetType ()

  
Public function Virtual Const bool If the node has any dynamic pins that can change based on input or settings
Public function Virtual Const bool Display generated title line as primary title (example: BP nodes display the blueprint name as the primary title).
Protected function Virtual Const TArray< FPCGPinProperties > Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins.
Public function Virtual Const bool

IsPinStaticallyActive ( const FName& OutputPinLabel
)

 True if we know prior to execution that the given pin will be active (not on inactive branch).
Public function Virtual Const bool Returns true if InPin is in use by node (assuming node enabled).
Protected function Virtual void

OnOverrideSettingsDuplicatedInternal ( bool bSkippedPostLoad
)

 Can be overriden by child class if some fixup code needs to run after duplication in the context of FPCGContext::InitializeSettings
Protected function Virtual Const TArray< FPCGPinProperties >  
Public function Virtual Const bool Whether this node can deactivate its output pins during execution, which can dynamically cull downstream nodes.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page