1. Epic GamesDeveloper
  3. UPCGSpawnActorSettings

UPCGSpawnActorSettings

PCG settings class that allows spawning actors with some options to perform the work more efficiently.

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural))  
class UPCGSpawnActorSettings : public UPCGBaseSubgraphSettings

Remarks

PCG settings class that allows spawning actors with some options to perform the work more efficiently. Note that depending on the options, any PCG components on the spawned actors can be also generated, which is why this class derives from UPCGBaseSubgraphSettings - it has similar inner-workings to the subgraph node as far as data passing and dispatch go. Note that at this point in time, results from the underlying graphs being generated is not propagated back as results of this node.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EPCGAttachOptions AttachOptions  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bAllowTemplateActorEditing  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bForceDisableActorParsing  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bInheritActorTags Warning: inheriting parent actor tags work only in non-collapsed actor hierarchies
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bSpawnByAttribute  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite EPCGSpawnActorGenerationTrigger GenerationTrigger  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EPCGSpawnActorOption Option  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TArray< FName > PostSpawnFunctionNames Can specify a list of functions from the template class to be called on each actor spawned, in order.
Public variable UProperty Meta TSoftObjectPtr< AActor > RootActor  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FName SpawnAttribute  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TArray< FPCGObjectPropertyOverrideDescription > SpawnedActorPropertyOverrideDescriptions  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TArray< FName > TagsToAddOnActors  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite instanced TObjectPtr< AActor > TemplateActor  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly TSubclassOf< AActor > TemplateActorClass  

Constructors

  Type Name Description
Public function  

UPCGSpawnActorSettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const bool  
Public function Static UPCGGraphInterface *

GetGraphInterfaceFromActorSubclass ( TSubclassOf< AActor > InTemplateActorClass
)

  
Public function Const const TSubclassOf< AActor > &  
Public function void

OnBlueprintChanged ( UBlueprint* Blueprint
)

  
Public function void

SetAllowTemplateActorEditing ( bool bInAllowTemplateActorEditing
)

  
Public function void

SetTemplateActorClass ( const TSubclassOf< AActor >& InTemplateActorClass
)

  
Protected function void  
Protected function void  

Overridden from UPCGBaseSubgraphSettings

  Type Name Description
Public function Virtual void  
Public function Virtual Const UPCGGraphInterface *  
Public function Virtual Const bool When using spawn by attribute, the potential execution of subgraphs will be done in a dynamic manner.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

  
Public function Virtual void  

Overridden from UPCGSettings

  Type Name Description
Protected function Virtual Const FPCGElementPtr  
Public function Virtual Const UPCGNode *  
Protected function Virtual Const EPCGChangeType

GetChangeTypeForProperty ( const FName& InPropertyName
)

 Gets the change impact for a given property.
Public function Virtual Const FName  
Public function Virtual Const FText  
Public function Virtual Const EPCGSettingsType

GetType ()

  
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  
Public function Virtual void  

Deprecated Variables

  Type Name Description
Protected variable UProperty TArray< FPCGActorPropertyOverride > ActorOverrides_DEPRECATED  
Protected variable UProperty EPCGSpawnActorGenerationTrigger bGenerationTrigger_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page