1. Epic GamesDeveloper
  3. UPCGSettings

UPCGSettings

Base class for settings-as-data in the PCG framework

API > API/Plugins > API/Plugins/PCG

Inheritance Hierarchy

References

   
Module PCG
Header /Engine/Plugins/Experimental/PCG/Source/PCG/Public/PCGSettings.h
Include #include "PCGSettings.h"

Syntax

UCLASS&40;Abstract, BlueprintType, ClassGroup&61;&40;Procedural&41;&41;  
class UPCGSettings : public UPCGSettingsInterface

Remarks

Base class for settings-as-data in the PCG framework

Variables

  Type Name Description
Public variable bool bExposeToLibrary  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bPassThroughFilteredOutInputs Warning - this is deprecated and will be removed soon since we have a Filter By Tag node for this specific purpose
Protected variable UProperty Category, Meta Transient visibleanywhere bool bUseSeed By default, settings won't use a seed. Set this bool to true in the child ctor to allow edition and use it.
Protected variable UProperty TArray< FPCGSettingsOverridableParam > CachedOverridableParams Needs to be serialized since property metadata (used to populate this array) is not available at runtime.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable FText Category  
Public variable int32 DataVersion The version number of the data after load and after any data migration.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite assetregistrysearchable FText Description  
Public variable UProperty FPCGDeterminismSettings DeterminismSettings  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TSet< FString > FilterOnTags Warning - this is deprecated and will be removed soon since we have a Filter By Tag node for this specific purpose
Public variable const UPCGSettings * OriginalSettings Holds the original settings used to duplicate this object if it was overridden.
Public variable int Seed  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TSet< FString > TagsAppliedOnOutput Applies the specified tags on the output data.
Public variable int32 UserDataVersion If a custom version guid was provided through GetUserCustomVersionGuid(), this field will hold the version number after load and after any data migration.

Functions

  Type Name Description
Public function Virtual Const FName Derived classes can implement this to expose additional name information in the logs
Public function Const TArray< FPCGPinProperties > Return the concatenation of InputPinProperties and FillOverridableParamsPins
Public function Const TArray< FPCGPinProperties > For symmetry reason, do the same with output pins.
Public function Virtual void

ApplyDeprecation ( UPCGNode* InOutNode
)

 Any final migration/recovery that can be done after pins are finalized.
Public function Virtual void

ApplyDeprecationBeforeUpdatePins ( UPCGNode* InOutNode,
TArray< TObjectPtr< UPCGPin >>& InputPins,
TArray< TObjectPtr< UPCGPin >>& OutputPins
)

 UpdatePins will kick off invalid edges, so this is useful for moving edges around in case of pin changes.
Public function Virtual void  
Public function Virtual void If settings require structural changes, this will apply them
Protected function Virtual Const FPCGElementPtr  
Public function Virtual Const UPCGNode *  
Public function Virtual Const TArray< FPCGPinProperties > Internal functions, should not be used by any user.
Public function Virtual Const TArray< FPCGPinProperties >  
Protected function Const TArray< FPCGPinProperties > Methods to remove boilerplate code across settings
Protected function Const TArray< FPCGPinProperties >  
Protected function void Method that can be called to dirty the cache data from this settings objects if the operator== does not allow to detect changes
Protected function Const void Iterate over OverridableParams to automatically add param pins to the list.
Protected function Virtual Const void There is a weird issue where the BP class is not set correctly in some Server cases.
Protected function Virtual Const TArray< FPCGSettingsOverridableParam > Can be overridden to add more custom params (like in BP).
Public function Const const FPCGCrc & Get the Crc value precomputed for these settings.
Public function Virtual Const EPCGDataType

GetCurrentPinTypes ( 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.
Public function Virtual Const FName  
Public function Virtual Const FText  
Public function Const FPCGElementPtr TODO: check if we need this to be virtual, we don't really need if we're always caching.
Public function Virtual Const UObject * Override this class to provide an UObject to jump to in case of double click on node ie. returning a blueprint instance will open the given blueprint in its editor.
Public function Virtual Const FLinearColor  
Public function Virtual Const FText  
Public function Virtual Const bool

GetPinExtraIcon ( const UPCGPin* InPin,
FName& OutExtraIcon,
FText& OutTooltip
)

 Can override to add a custom icon next to the pin label (and an optional tooltip).
Public function Virtual Const bool

GetPinLabelStyle ( const UPCGPin* InPin,
FName& OutLabelStyle
)

 Can override the label style for a pin. Return false if no override is available.
Public function Virtual Const TArray< FPCGPreConfiguredSettingsInfo > Return preconfigured info that will be filled in the editor palette action, allowing to create pre-configured settings
Public function Const int

GetSeed ( const UPCGComponent* InSourceComponent
)

 Get the seed, combined with optional PCGComponent seed.
Public function Virtual Const void

GetTrackedActorKeys ( FPCGActorSelectionKeyToSettingsMap& OutKeysToSettings,
TArray< TObjectPtr< const UPCGGraph >>& OutVisitedGraphs
)

 Derived classes must implement this to communicate dependencies on external actors
Public function Virtual Const EPCGSettingsType

GetType ()

  
Protected function Virtual Const uint32 Can be overriden by child class if they ever got renamed to avoid changing the default seed for this one.
Public function Const EPCGDataType

GetTypeUnionOfIncidentEdges ( const FName& PinLabel
)

 Bitwise union of the allowed types of each incident edge on pin.
Protected function Virtual FGuid An additional custom version number that external system users can use to track versions.
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 Check if we have some override. Can be overriden to force params pin for example
Protected function void Called after intialization to construct the list of all overridable params.
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 Returns true if InPin is in use by node (assuming node enabled).
Public function Virtual Const bool

IsPropertyOverriddenByPin ( const FProperty* InProperty
)

  
Protected function Virtual Const bool

IsStructuralProperty ( const FName& InPropertyName
)

  
Public function Virtual Const bool If there are preconfigured info, we can skip the default settings and only expose pre-configured actions in the editor palette
Public function Virtual Const bool Returns true if only the first input edge is used from the primary pin when the node is disabled.
Protected function Virtual Const TArray< FPCGPinProperties >  
Public function Virtual Const const TArray< FPCGSettingsOverridableParam > & Overridable param section.
Public function Virtual Const bool Puts node title on node body, reducing overall node size
Public function Virtual Const bool Check if we need to hook the output of the pre-task to this.
Public function Const bool

UseSeed ()

  

Overridden from UPCGSettingsInterface

  Type Name Description
Public function Virtual Const const UPCGSettings *  
Public function Virtual UPCGSettings *  

Overridden from UPCGData

  Type Name Description
Public function Virtual Const EPCGDataType  

Overridden from UObject

  Type Name Description
Protected function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Passthrough for the simpler method, to avoid modifying the child settings already overriding this method.
Protected function Virtual Const bool

CanEditChange ( const FEditPropertyChain& InPropertyChain
)

 We need the more complex function (with PropertyChain) to detect child properties in structs, if they are overridable.
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Called from within SavePackage on the passed in base/root object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Operators

  Type Name Description
Public function Const bool

operator== ( const UPCGSettings& Other
)

  

Deprecated Variables

  Type Name Description
Public variable EPCGSettingsExecutionMode ExecutionMode_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page