Navigation
API > API/Plugins > API/Plugins/PCG
| Name | UPCGStaticMeshSpawnerSettings |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGStaticMeshSpawner.h |
| Include Path | #include "Elements/PCGStaticMeshSpawner.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural), Meta=(prioritizeCategories="Settings"))
class UPCGStaticMeshSpawnerSettings : public UPCGSettings
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSettingsInterface → UPCGSettings → UPCGStaticMeshSpawnerSettings
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPCGStaticMeshSpawnerSettings
(
const FObjectInitializer& ObjectInitializer |
Elements/PCGStaticMeshSpawner.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAllowDescriptorChanges | bool | Allows PCG to make some changes on the descriptors as situation arises (using ISM instead of HISM for nanite meshes, etc.) | Elements/PCGStaticMeshSpawner.h |
|
| bAllowMergeDifferentDataInSameInstancedComponents | bool | Controls whether instances stemming from different data can end up in the same ISM. | Elements/PCGStaticMeshSpawner.h |
|
| bApplyMeshBoundsToPoints | bool | Sets the BoundsMin and BoundsMax attributes of each point to reflect the StaticMesh spawned at its location | Elements/PCGStaticMeshSpawner.h |
|
| bSilenceOverrideAttributeNotFoundErrors | bool | Opt-in option to silence errors when the property override attributes are not found. | Elements/PCGStaticMeshSpawner.h |
|
| bSynchronousLoad | bool | Meshes/Materials will be synchronously loaded before spawning instead of asynchronously. | Elements/PCGStaticMeshSpawner.h |
|
| bWarnOnIdenticalSpawn | bool | Adds a warning to the node on repeated spawning with identical conditions (ie. same mesh descriptor at same spawn location, etc). | Elements/PCGStaticMeshSpawner.h |
|
| InstanceDataPackerParameters | TObjectPtr< UPCGInstanceDataPackerBase > | Elements/PCGStaticMeshSpawner.h |
|
|
| InstanceDataPackerType | TSubclassOf< UPCGInstanceDataPackerBase > | Defines the method of custom data packing for spawned (H)ISMCs. | Elements/PCGStaticMeshSpawner.h |
|
| MeshSelectorParameters | TObjectPtr< UPCGMeshSelectorBase > | Elements/PCGStaticMeshSpawner.h |
|
|
| MeshSelectorType | TSubclassOf< UPCGMeshSelectorBase > | Defines the method of mesh selection per input data | Elements/PCGStaticMeshSpawner.h |
|
| OutAttributeName | FName | Attribute name to store mesh SoftObjectPaths inside if the output pin is connected. | Elements/PCGStaticMeshSpawner.h |
|
| PostProcessFunctionNames | TArray< FName > | Specify a list of functions to be called on the target actor after instances are spawned. | Elements/PCGStaticMeshSpawner.h |
|
| StaticMeshComponentPropertyOverrides | TArray< FPCGObjectPropertyOverrideDescription > | Map an attribute directly to an ISM Descriptor property, the value of which will be overriden when generated. | Elements/PCGStaticMeshSpawner.h |
|
| TargetActor | TSoftObjectPtr< AActor > | Elements/PCGStaticMeshSpawner.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetInstancePackerType
(
TSubclassOf< UPCGInstanceDataPackerBase > InInstancePackerType |
Elements/PCGStaticMeshSpawner.h |
|
|
void SetMeshSelectorType
(
TSubclassOf< UPCGMeshSelectorBase > InMeshSelectorType |
Elements/PCGStaticMeshSpawner.h |
|
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ApplyDeprecation
(
UPCGNode* InOutNode |
Any final migration/recovery that can be done after pins are finalized. | Elements/PCGStaticMeshSpawner.h | |
virtual void CreateKernels
(
FPCGGPUCompilationContext& InOutContext, |
Create the GPU kernels and kernel edges that should execute for this node. | Elements/PCGStaticMeshSpawner.h | |
virtual bool DisplayExecuteOnGPUSetting() |
Whether to display GPU execution option in node settings UI. | Elements/PCGStaticMeshSpawner.h | |
virtual FName GetDefaultNodeName() |
Elements/PCGStaticMeshSpawner.h | ||
virtual FText GetDefaultNodeTitle() |
Elements/PCGStaticMeshSpawner.h | ||
virtual EPCGSettingsType GetType() |
Elements/PCGStaticMeshSpawner.h | ||
virtual bool UseSeed () |
By default, settings do not use a seed. | Elements/PCGStaticMeshSpawner.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanEditChange
(
const FProperty* InProperty |
Passthrough for the simpler method, to avoid modifying the child settings already overriding this method. | Elements/PCGStaticMeshSpawner.h | |
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Elements/PCGStaticMeshSpawner.h | ||
virtual void PostLoad() |
Elements/PCGStaticMeshSpawner.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void RefreshInstancePacker() |
Elements/PCGStaticMeshSpawner.h | ||
void RefreshMeshSelector() |
Elements/PCGStaticMeshSpawner.h |
Overridden from UPCGSettings
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPCGElementPtr CreateElement() |
Elements/PCGStaticMeshSpawner.h | ||
virtual TArray< FPCGPinProperties > InputPinProperties() |
Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins. | Elements/PCGStaticMeshSpawner.h | |
virtual TArray< FPCGPinProperties > OutputPinProperties() |
Elements/PCGStaticMeshSpawner.h |