Navigation
API > API/Plugins > API/Plugins/PCG
Selects data from any number of input pins, based on a static selection criteria (Int/String/Enum)
| Name | UPCGMultiSelectSettings |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Elements/ControlFlow/PCGMultiSelect.h |
| Include Path | #include "Elements/ControlFlow/PCGMultiSelect.h" |
Syntax
UCLASS (BlueprintType, ClassGroup=(Procedural), Meta=(Keywords="if multi switch enum"))
class UPCGMultiSelectSettings : public UPCGControlFlowSettings
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGControlFlowSettings → UPCGMultiSelectSettings
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedPinLabels | TArray< FName > | Cached pin labels for use during the selection process. | Elements/ControlFlow/PCGMultiSelect.h |
|
| EnumSelection | FEnumSelector | Determines which input pin will be selected if the selection mode is Enum. | Elements/ControlFlow/PCGMultiSelect.h |
|
| EnumValueToPinLabelMapping | TMap< int64, FName > | Since we use the Display name as the output pins for enums, this can be different in non-editor build. | Elements/ControlFlow/PCGMultiSelect.h | |
| IntegerSelection | int32 | Determines which input will be selected if the selection mode is Integer. | Elements/ControlFlow/PCGMultiSelect.h |
|
| IntOptions | TArray< int32 > | Determines the available input pin selection options. | Elements/ControlFlow/PCGMultiSelect.h |
|
| SelectionMode | EPCGControlFlowSelectionMode | Determines the type of value to be used to select an input. | Elements/ControlFlow/PCGMultiSelect.h |
|
| StringOptions | TArray< FString > | Determines the available input pin selection options. | Elements/ControlFlow/PCGMultiSelect.h |
|
| StringSelection | FString | Determines which input will be selected if the selection mode is String. | Elements/ControlFlow/PCGMultiSelect.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FPCGMultiSelectElement | friend | Elements/ControlFlow/PCGMultiSelect.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void UpdateSettings() |
To be called after the settings are modified directly in native code. | Elements/ControlFlow/PCGMultiSelect.h |
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetAdditionalTitleInformation() |
Derived classes can implement this to expose additional information or context, such as an asset in use by the node. | Elements/ControlFlow/PCGMultiSelect.h | |
virtual FPCGDataTypeIdentifier GetCurrentPinTypesID
(
const UPCGPin* InPin |
Returns the current pin types, which can either be the static types from the pin properties, or a dynamic type based on connected edges. | Elements/ControlFlow/PCGMultiSelect.h | |
virtual FName GetDefaultNodeName() |
Elements/ControlFlow/PCGMultiSelect.h | ||
virtual FText GetDefaultNodeTitle() |
Elements/ControlFlow/PCGMultiSelect.h | ||
virtual FText GetNodeTooltipText() |
Elements/ControlFlow/PCGMultiSelect.h | ||
virtual EPCGSettingsType GetType() |
Elements/ControlFlow/PCGMultiSelect.h | ||
virtual bool HasDynamicPins() |
If the node has any dynamic pins that can change based on input or settings | Elements/ControlFlow/PCGMultiSelect.h | |
virtual bool HasFlippedTitleLines() |
Display generated title line as primary title (example: BP nodes display the blueprint name as the primary title). | Elements/ControlFlow/PCGMultiSelect.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Elements/ControlFlow/PCGMultiSelect.h | ||
virtual void PostLoad() |
Elements/ControlFlow/PCGMultiSelect.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CacheEnumValueToPinLabelsMapping() |
Elements/ControlFlow/PCGMultiSelect.h | ||
void CachePinLabels() |
Elements/ControlFlow/PCGMultiSelect.h | ||
bool GetSelectedPinLabel
(
FName& OutSelectedPinLabel |
Helper function to use the appropriate selection value to determine the current selection. | Elements/ControlFlow/PCGMultiSelect.h | |
bool IsValuePresent
(
int32 Value |
Returns true if the integer value exists in the user defined array. | Elements/ControlFlow/PCGMultiSelect.h | |
bool IsValuePresent
(
const FString& Value |
Returns true if the string value exists in the user defined array. | Elements/ControlFlow/PCGMultiSelect.h | |
bool IsValuePresent
(
int64 Value |
Returns true if the enum value exists within the enum class. | Elements/ControlFlow/PCGMultiSelect.h |
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPCGElementPtr CreateElement() |
Elements/ControlFlow/PCGMultiSelect.h | ||
virtual TArray< FPCGPinProperties > InputPinProperties() |
Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins. | Elements/ControlFlow/PCGMultiSelect.h | |
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 | Elements/ControlFlow/PCGMultiSelect.h | |
virtual TArray< FPCGPinProperties > OutputPinProperties() |
Elements/ControlFlow/PCGMultiSelect.h |