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]

  • filter_on_tags (Set[str]): [Read-Write] Warning - this is deprecated and will be removed soon since we have a Filter By Tag node for this specific purpose

  • 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

  • meshes (Array[PCGStaticMeshSpawnerEntry]): [Read-Write] deprecated: Use MeshSelectorType and MeshSelectorParameters instead.

  • 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.

  • pass_through_filtered_out_inputs (bool): [Read-Write] Warning - this is deprecated and will be removed soon since we have a Filter By Tag node for this specific purpose

  • seed (int32): [Read-Write]

  • tags_applied_on_output (Set[str]): [Read-Write] Applies the specified tags on the output data. Note - this might be replaced by a dedicated Tagging node

  • 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 meshes: None

[Read-Write] deprecated: Use MeshSelectorType and MeshSelectorParameters instead.

Type:

(Array[PCGStaticMeshSpawnerEntry])

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

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 target_actor: Actor

[Read-Write]

Type:

(Actor)