unreal.PCGStaticMeshSpawnerSettings

class unreal.PCGStaticMeshSpawnerSettings(outer: Object | None = None, name: Name | str = 'None')

Bases: PCGSettings

PCGStatic Mesh Spawner Settings

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGStaticMeshSpawner.h

Editor Properties: (see get_editor_property/set_editor_property)

  • apply_mesh_bounds_to_points (bool): [Read-Write] Sets the BoundsMin and BoundsMax attributes of each point to reflect the StaticMesh spawned at its location

  • break_debugger (bool): [Read-Write] If a debugger is attached, triggers a breakpoint inside IPCGElement::Execute(). Editor only. Transient.

  • category (Text): [Read-Write]

  • debug (bool): [Read-Write]

  • debug_settings (PCGDebugVisualizationSettings): [Read-Write]

  • description (Text): [Read-Write]

  • determinism_settings (PCGDeterminismSettings): [Read-Write]

  • enabled (bool): [Read-Write]

  • expose_to_library (bool): [Read-Write]

  • instance_data_packer_parameters (PCGInstanceDataPackerBase): [Read-Only]

  • instance_data_packer_type (type(Class)): [Read-Write] Defines the method of custom data packing for spawned (H)ISMCs

  • mesh_selector_parameters (PCGMeshSelectorBase): [Read-Only]

  • mesh_selector_type (type(Class)): [Read-Write] Defines the method of mesh selection per input data

  • out_attribute_name (Name): [Read-Write] Attribute name to store mesh SoftObjectPaths inside if the output pin is connected. Note: Will overwrite existing data if the attribute name already exists.

  • post_process_function_names (Array[Name]): [Read-Write] Specify a list of functions to be called on the target actor after instances are spawned. Functions need to be parameter-less and with “CallInEditor” flag enabled.

  • seed (int32): [Read-Write]

  • silence_override_attribute_not_found_errors (bool): [Read-Write] Opt-in option to silence errors when the property override attributes are not found.

  • static_mesh_component_property_overrides (Array[PCGObjectPropertyOverrideDescription]): [Read-Write] Map an attribute directly to an ISM Descriptor property, the value of which will be overriden when generated. Note: Currently only enabled using SelectByAttribute mesh selection.

  • synchronous_load (bool): [Read-Write] Meshes/Materials will be synchronously loaded before spawning instead of asynchronously.

  • target_actor (Actor): [Read-Write]

  • use_seed (bool): [Read-Only] By default, settings won’t use a seed. Set this bool to true in the child ctor to allow edition and use it.

property apply_mesh_bounds_to_points: bool

[Read-Write] Sets the BoundsMin and BoundsMax attributes of each point to reflect the StaticMesh spawned at its location

Type:

(bool)

property instance_data_packer_parameters: PCGInstanceDataPackerBase

[Read-Only]

Type:

(PCGInstanceDataPackerBase)

property instance_data_packer_type: Class

[Read-Only] Defines the method of custom data packing for spawned (H)ISMCs

Type:

(type(Class))

property instance_packer_instance: PCGInstanceDataPackerBase

‘instance_packer_instance’ was renamed to ‘instance_data_packer_parameters’.

Type:

deprecated

property instance_packer_type: Class

‘instance_packer_type’ was renamed to ‘instance_data_packer_type’.

Type:

deprecated

property mesh_selector_instance: PCGMeshSelectorBase

‘mesh_selector_instance’ was renamed to ‘mesh_selector_parameters’.

Type:

deprecated

property mesh_selector_parameters: PCGMeshSelectorBase

[Read-Only]

Type:

(PCGMeshSelectorBase)

property mesh_selector_type: Class

[Read-Only] Defines the method of mesh selection per input data

Type:

(type(Class))

property out_attribute_name: Name

Will overwrite existing data if the attribute name already exists.

Type:

(Name)

Type:

[Read-Write] Attribute name to store mesh SoftObjectPaths inside if the output pin is connected. Note

property post_process_function_names: None

[Read-Write] Specify a list of functions to be called on the target actor after instances are spawned. Functions need to be parameter-less and with “CallInEditor” flag enabled.

Type:

(Array[Name])

set_instance_packer_type(instance_packer_type) → None

Set Instance Packer Type

Parameters:

instance_packer_type (type(Class)) –

set_mesh_selector_type(mesh_selector_type) → None

Set Mesh Selector Type

Parameters:

mesh_selector_type (type(Class)) –

property silence_override_attribute_not_found_errors: bool

[Read-Write] Opt-in option to silence errors when the property override attributes are not found.

Type:

(bool)

property static_mesh_component_property_overrides: None

[Read-Write] Map an attribute directly to an ISM Descriptor property, the value of which will be overriden when generated. Note: Currently only enabled using SelectByAttribute mesh selection.

Type:

(Array[PCGObjectPropertyOverrideDescription])

property synchronous_load: bool

[Read-Write] Meshes/Materials will be synchronously loaded before spawning instead of asynchronously.

Type:

(bool)

property target_actor: Actor

[Read-Write]

Type:

(Actor)