UPCGPythonDataProcessorSettings

Execute a Python script with direct access to PCG data collections.

API > API/Plugins > API/Plugins/PCGPythonInteropEditor

Execute a Python script with direct access to PCG data collections. Dynamic pins accept any PCG data type with multi-connection and multi-data. The user receives an FPCGDataCollection for input and builds one for output.

   
Name UPCGPythonDataProcessorSettings
Type class
Header File /Engine/Plugins/PCGInterops/PCGPythonInterop/Source/PCGPythonInteropEditor/Public/Elements/PCGPythonDataProcessor.h
Include Path #include "Elements/PCGPythonDataProcessor.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))  
class UPCGPythonDataProcessorSettings :  
    public UPCGSettings ,  
    public IPCGDynamicPinsProvider ,  
    public IPCGSettingsDefaultValueProvider

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGPythonDataProcessorSettings()

   Elements/PCGPythonDataProcessor.h  

Constants

Name Type Remarks Include Path
DefaultInlineScript const FString   Elements/PCGPythonDataProcessor.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bMuteEditorToast bool   Elements/PCGPythonDataProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • AdvancedDisplay
  • Meta=(PCG_Overridable)
InputDynamicPins FPCGDynamicPinContainer   Elements/PCGPythonDataProcessor.h  
OutputDynamicPins FPCGDynamicPinContainer   Elements/PCGPythonDataProcessor.h  
ScriptInputMethod EPCGPythonScriptInputMethod The method for receiving the intended Python source. Elements/PCGPythonDataProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
ScriptPath FFilePath The path to the .py file that will be executed. Elements/PCGPythonDataProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="ScriptInputMethod == EPCGPythonScriptInputMethod::File", EditConditionHides, FilePathFilter="Python files (.py)|.py")
ScriptSource FPCGAttributePropertyInputSelector Which attribute to use as a script source. Elements/PCGPythonDataProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(PCG_Overridable, EditCondition="ScriptInputMethod == EPCGPythonScriptInputMethod::Input", EditConditionHides)

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsDefaultValueActivated bool   Elements/PCGPythonDataProcessor.h  
InlineScript FString   Elements/PCGPythonDataProcessor.h  

Functions

Public Virtual

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual bool CanCullTaskIfUnwired()

   Elements/PCGPythonDataProcessor.h  

virtual FString GetAdditionalTitleInformation()

   Elements/PCGPythonDataProcessor.h  

virtual FName GetDefaultNodeName()

   Elements/PCGPythonDataProcessor.h  

virtual FText GetDefaultNodeTitle()

   Elements/PCGPythonDataProcessor.h  

virtual FText GetNodeTooltipText()

   Elements/PCGPythonDataProcessor.h  

virtual EPCGSettingsType GetType()

   Elements/PCGPythonDataProcessor.h  

virtual bool HasDynamicPins()

   Elements/PCGPythonDataProcessor.h  

virtual bool IsInputPinRequiredByExecution ( const UPCGPin* InPin
) const

   Elements/PCGPythonDataProcessor.h  

Overridden from IPCGDynamicPinsProvider

Name Remarks Include Path Unreal Specifiers

virtual bool CanUserRenameDynamicPin ( EPCGPinDirection Direction
) const

   Elements/PCGPythonDataProcessor.h  

virtual FPCGPinProperties CreateDefaultDynamicPin ( EPCGPinDirection Direction
) const

   Elements/PCGPythonDataProcessor.h  

virtual const FPCGDynamicPinContainer * GetDynamicPinContainer ( EPCGPinDirection Direction
) const

   Elements/PCGPythonDataProcessor.h  

virtual FPCGDynamicPinContainer * GetMutableDynamicPinContainer ( EPCGPinDirection Direction
)

   Elements/PCGPythonDataProcessor.h  

virtual TArray< FPCGPinProperties > GetStaticPinProperties ( EPCGPinDirection Direction
) const

   Elements/PCGPythonDataProcessor.h  

Overridden from IPCGSettingsDefaultValueProvider

Name Remarks Include Path Unreal Specifiers

virtual bool CreateInitialDefaultValueAttribute ( FName PinLabel,
UPCGMetadata* OutMetadata
) const

   Elements/PCGPythonDataProcessor.h  

virtual bool DefaultValuesAreEnabled()

   Elements/PCGPythonDataProcessor.h  

virtual EPCGSettingDefaultValueExtraFlags GetDefaultValueExtraFlags ( FName PinLabel
) const

   Elements/PCGPythonDataProcessor.h  

virtual FString GetPinDefaultValueAsString ( FName PinLabel
) const

   Elements/PCGPythonDataProcessor.h  

virtual EPCGMetadataTypes GetPinDefaultValueType ( FName PinLabel
) const

   Elements/PCGPythonDataProcessor.h  

virtual FString GetPinInitialDefaultValueString ( FName PinLabel
) const

   Elements/PCGPythonDataProcessor.h  

virtual bool IsPinDefaultValueActivated ( FName PinLabel
) const

   Elements/PCGPythonDataProcessor.h  

virtual bool IsPinDefaultValueEnabled ( FName PinLabel
) const

   Elements/PCGPythonDataProcessor.h  

virtual bool IsPinDefaultValueMetadataTypeValid ( FName PinLabel,
EPCGMetadataTypes DataType
) const

   Elements/PCGPythonDataProcessor.h  

virtual void ResetDefaultValue ( FName PinLabel
)

   Elements/PCGPythonDataProcessor.h  

virtual void ResetDefaultValues()

   Elements/PCGPythonDataProcessor.h  

virtual void SetPinDefaultValue ( FName PinLabel,
const FString& DefaultValue,
bool bCreateIfNeeded
)

   Elements/PCGPythonDataProcessor.h  

virtual void SetPinDefaultValueIsActivated ( FName PinLabel,
bool bIsActivated,
bool bDirtySettings
)

   Elements/PCGPythonDataProcessor.h  

Protected Virtual

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual FPCGElementPtr CreateElement()

   Elements/PCGPythonDataProcessor.h  

virtual EPCGChangeType GetChangeTypeForProperty ( const FName& InPropertyName
) const

   Elements/PCGPythonDataProcessor.h  

virtual TArray< FPCGPinProperties > InputPinProperties()

   Elements/PCGPythonDataProcessor.h  

virtual TArray< FPCGPinProperties > OutputPinProperties()

   Elements/PCGPythonDataProcessor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Elements/PCGPythonDataProcessor.h  

Overridden from IPCGSettingsDefaultValueProvider

Name Remarks Include Path Unreal Specifiers

virtual EPCGMetadataTypes GetPinInitialDefaultValueType ( FName PinLabel
) const

   Elements/PCGPythonDataProcessor.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool SupportsComposition()

   Elements/PCGPythonDataProcessor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page