1. Epic GamesDeveloper
  3. UPCGStaticMeshSpawnerSettings

UPCGStaticMeshSpawnerSettings

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (BlueprintType, ClassGroup=(Procedural), Meta=(prioritizeCategories="Settings"))  
class UPCGStaticMeshSpawnerSettings : public UPCGSettings

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bAllowDescriptorChanges Allows PCG to make some changes on the descriptors as situation arises (using ISM instead of HISM for nanite meshes, etc.)
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bApplyMeshBoundsToPoints Sets the BoundsMin and BoundsMax attributes of each point to reflect the StaticMesh spawned at its location
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bSilenceOverrideAttributeNotFoundErrors Opt-in option to silence errors when the property override attributes are not found.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bSynchronousLoad Meshes/Materials will be synchronously loaded before spawning instead of asynchronously.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bWarnOnIdenticalSpawn Adds a warning to the node on repeated spawning with identical conditions (ie. same mesh descriptor at same spawn location, etc).
Public variable UProperty Category BlueprintReadOnly instanced, visibleanywhere TObjectPtr< UPCGInstanceDataPackerBase > InstanceDataPackerParameters  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TSubclassOf< UPCGInstanceDataPackerBase > InstanceDataPackerType Defines the method of custom data packing for spawned (H)ISMCs.
Public variable UProperty Category BlueprintReadOnly instanced, visibleanywhere TObjectPtr< UPCGMeshSelectorBase > MeshSelectorParameters  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly noclear TSubclassOf< UPCGMeshSelectorBase > MeshSelectorType Defines the method of mesh selection per input data
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName OutAttributeName Attribute name to store mesh SoftObjectPaths inside if the output pin is connected.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FName > PostProcessFunctionNames Specify a list of functions to be called on the target actor after instances are spawned.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FPCGObjectPropertyOverrideDescription > StaticMeshComponentPropertyOverrides Map an attribute directly to an ISM Descriptor property, the value of which will be overriden when generated.
Public variable UProperty Category, Meta BlueprintReadWrite TSoftObjectPtr< AActor > TargetActor  

Constructors

  Type Name Description
Public function  

UPCGStaticMeshSpawnerSettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Protected function void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  

Overridden from UPCGSettings

  Type Name Description
Public function Virtual Const void

AddStaticCreatedStrings ( TArray< FString >& InOutStringTable
)

 [EXPERIMENTAL] Add any strings emitted by this node that are known statically at compile time.
Public function Virtual void

ApplyDeprecation ( UPCGNode* InOutNode
)

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

CanEditChange ( const FProperty* InProperty
)

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

ComputeKernelThreadCount ( const UPCGDataBinding* Binding
)

 [EXPERIMENTAL] Compute how many threads should be dispatched to execute this node on the GPU.
Public function Virtual Const bool

ComputeOutputPinDataDesc ( const UPCGPin* OutputPin,
const UPCGDataBinding* InBinding,
FPCGDataCollectionDesc& OutDesc
)

 [EXPERIMENTAL] Compute a description of data that will be output from OutputPinLabel/OutputPin.
Public function Virtual Const void

CreateAdditionalInputDataInterfaces ( FPCGGPUCompilationContext& InOutContext,
UObject* InObjectOuter,
TArray< TObjectPtr< UComputeDataInterface > >& OutDataInterfaces
)

 [EXPERIMENTAL] Create additional input data interfaces to marshal any required input data.
Public function Virtual Const void

CreateAdditionalOutputDataInterfaces ( FPCGGPUCompilationContext& InOutContext,
UObject* InObjectOuter,
TArray< TObjectPtr< UComputeDataInterface > >& OutDataInterfaces
)

 [EXPERIMENTAL] Create additional output data interfaces to marshal any required output data.
Protected function Virtual Const FPCGElementPtr  
Public function Virtual Const bool [EXPERIMENTAL] Whether to display GPU execution option in node settings UI.
Public function Virtual Const FString

GetCookedKernelSource ( const TMap< FName, FPCGKernelAttributeIDAndType >& GlobalAttributeLookupTable
)

 [EXPERIMENTAL] Produces the node specific portion of kernel shader source text, including the main entry point.
Public function Virtual Const FName  
Public function Virtual Const FText  
Public function Virtual Const void

GetKernelAttributeKeys ( TArray< FPCGKernelAttributeKey >& OutKeys
)

 [EXPERIMENTAL] Get a list of the attributes read or written by this node.
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.
Public function Virtual Const bool

IsKernelValid ( FPCGContext* InContext,
bool bQuiet
)

 [EXPERIMENTAL] Performs validation and returns true if this node is suitable for deployment to the GPU.
Protected function Virtual Const TArray< FPCGPinProperties >  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual Const bool

UseSeed ()

 By default, settings do not use a seed.

Constants

Name Description
TemplateFilePath  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page