1. Epic GamesDeveloper
  3. UPCGDataFromActorSettings

UPCGDataFromActorSettings

Builds a collection of PCG-compatible data from the selected actors.

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (BlueprintType, ClassGroup=(Procedural))  
class UPCGDataFromActorSettings : public UPCGSettings

Remarks

Builds a collection of PCG-compatible data from the selected actors.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FPCGActorSelectorSettings ActorSelector Describes which actors to select for data collection.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 AllowedGrids Select which grid sizes to consider when collecting data from partitioned PCG components.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bAlsoOutputSinglePointData Also produces a single point data at the actor location.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bComponentsMustOverlapSelf Only get data from components which overlap with the bounds of your source component.
Public variable UProperty Meta Transient bool bDisplayModeSettings This can be set false by inheriting nodes to hide the 'Mode' property.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bGetDataOnAllGrids Get data from all grid sizes if there is a partitioned PCG component on the actor, instead of a specific set of grid sizes.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bMergeSinglePointData Merges all the single point data outputs into a single point data.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bSilenceSanitizedAttributeNameWarnings Silence warnings that attribute names were sanitized to replace invalid characters.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bTrackActorsOnlyWithinBounds If this is checked, found actors that are outside component bounds will not trigger a refresh.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TArray< FName > ExpectedPins Provide pin names to match against the found component output pins.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EPCGGetDataFromActorMode Mode Describes what kind of data we will collect from the found actor(s).
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FName PropertyName The property name on the found actor to create a data collection from.

Functions

  Type Name Description
Public function Virtual Const EPCGDataType Override this to filter what kinds of data should be retrieved from the actor(s).
Public function Virtual Const TSubclassOf< AActor > Override this to change the default value the selector will revert to when changing the actor selection type

Overridden from UPCGSettings

  Type Name Description
Public function Virtual void

ApplyDeprecation ( UPCGNode* InOutNode
)

 Any final migration/recovery that can be done after pins are finalized.
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 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 Virtual Const FText  
Public function Virtual Const void

GetStaticTrackedKeys ( FPCGSelectionKeyToSettingsMap& OutKeysToSettings,
TArray< TObjectPtr< const UPCGGraph > >& OutVisitedGraphs
)

 Derived classes must implement this to communicate dependencies that are known statically.
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
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.
Protected function Virtual Const TArray< FPCGPinProperties >  
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