UPCGExecutePythonScriptSettings | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/PCGPythonInteropEditor

Execute a Python script, either inline, as input, or from a file.


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

Syntax

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

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGExecutePythonScriptSettings

Implements Interfaces

IPCGSettingsDefaultValueProvider

Constants

Name	Type	Remarks	Include Path
DefaultInlineScript	const FString	The default script to employ until replaced by the user's script.	Elements/PCGExecutePythonScript.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bMuteEditorToast	bool		Elements/PCGExecutePythonScript.h	EditAnywhere BlueprintReadWrite Category=Settings AdvancedDisplay Meta=(PCG_Overridable)
ScriptInputMethod	EPCGPythonScriptInputMethod	The method for receiving the intended Python source.	Elements/PCGExecutePythonScript.h	EditAnywhere BlueprintReadWrite Category=Settings
ScriptPath	FFilePath	The path to the .py file that will be executed.	Elements/PCGExecutePythonScript.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/PCGExecutePythonScript.h	EditAnywhere BlueprintReadWrite Category=Settings Meta=(PCG_Overridable, EditCondition="ScriptInputMethod == EPCGPythonScriptInputMethod::Input", EditConditionHides)

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
bIsDefaultValueActivated	bool	Inline constant is enabled for the input pin.	Elements/PCGExecutePythonScript.h
InlineScript	FString	Inline constant script on the input pin to run.	Elements/PCGExecutePythonScript.h

Functions

Public

Overridden from UPCGSettings

Name	Remarks	Include Path	Unreal Specifiers
virtual bool CanCullTaskIfUnwired()		Elements/PCGExecutePythonScript.h
virtual FString GetAdditionalTitleInformation()		Elements/PCGExecutePythonScript.h
virtual EPCGChangeType GetChangeTypeForProperty ( const FName& InPropertyName ) const		Elements/PCGExecutePythonScript.h
virtual FName GetDefaultNodeName()		Elements/PCGExecutePythonScript.h
virtual FText GetDefaultNodeTitle()		Elements/PCGExecutePythonScript.h
virtual FText GetNodeTooltipText()		Elements/PCGExecutePythonScript.h
virtual EPCGSettingsType GetType()		Elements/PCGExecutePythonScript.h
virtual bool IsInputPinRequiredByExecution ( const UPCGPin* InPin ) const		Elements/PCGExecutePythonScript.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual bool CanEditChange ( const FProperty* InProperty ) const		Elements/PCGExecutePythonScript.h

Overridden from IPCGSettingsDefaultValueProvider

Name	Remarks	Include Path	Unreal Specifiers
virtual bool CreateInitialDefaultValueAttribute ( FName PinLabel, UPCGMetadata* OutMetadata ) const		Elements/PCGExecutePythonScript.h
virtual bool DefaultValuesAreEnabled()		Elements/PCGExecutePythonScript.h
virtual EPCGSettingDefaultValueExtraFlags GetDefaultValueExtraFlags ( FName PinLabel ) const		Elements/PCGExecutePythonScript.h
virtual FString GetPinDefaultValueAsString ( FName PinLabel ) const		Elements/PCGExecutePythonScript.h
virtual EPCGMetadataTypes GetPinDefaultValueType ( FName PinLabel ) const		Elements/PCGExecutePythonScript.h
virtual FString GetPinInitialDefaultValueString ( FName PinLabel ) const		Elements/PCGExecutePythonScript.h
virtual bool IsPinDefaultValueActivated ( FName PinLabel ) const		Elements/PCGExecutePythonScript.h
virtual bool IsPinDefaultValueEnabled ( FName PinLabel ) const		Elements/PCGExecutePythonScript.h
virtual bool IsPinDefaultValueMetadataTypeValid ( FName PinLabel, EPCGMetadataTypes DataType ) const		Elements/PCGExecutePythonScript.h
virtual void ResetDefaultValue ( FName PinLabel )		Elements/PCGExecutePythonScript.h
virtual void ResetDefaultValues()		Elements/PCGExecutePythonScript.h
virtual void SetPinDefaultValue ( FName PinLabel, const FString& DefaultValue, bool bCreateIfNeeded )		Elements/PCGExecutePythonScript.h
virtual void SetPinDefaultValueIsActivated ( FName PinLabel, bool bIsActivated, bool bDirtySettings )		Elements/PCGExecutePythonScript.h

Protected

Overridden from UPCGSettings

Name	Remarks	Include Path	Unreal Specifiers
virtual FPCGElementPtr CreateElement()		Elements/PCGExecutePythonScript.h
virtual TArray< FPCGPinProperties > InputPinProperties()		Elements/PCGExecutePythonScript.h
virtual TArray< FPCGPinProperties > OutputPinProperties()		Elements/PCGExecutePythonScript.h

Overridden from IPCGSettingsDefaultValueProvider

Name	Remarks	Include Path	Unreal Specifiers
virtual EPCGMetadataTypes GetPinInitialDefaultValueType ( FName PinLabel ) const		Elements/PCGExecutePythonScript.h

Navigation

Syntax

Inheritance Hierarchy

Implements Interfaces

Constants

Variables

Public

Protected

Functions

Public

Overridden from UPCGSettings

Overridden from UObject

Overridden from IPCGSettingsDefaultValueProvider

Protected

Overridden from UPCGSettings

Overridden from IPCGSettingsDefaultValueProvider