unreal.PCGActorSelectorSettings

class unreal.PCGActorSelectorSettings(actor_filter: PCGActorFilter = Ellipsis, must_overlap_self: bool = False, include_children: bool = False, disable_filter: bool = False, actor_selection: PCGActorSelection = Ellipsis, actor_selection_tag: Name = 'None', actor_selection_class: Class = Ellipsis, actor_reference_selector: PCGAttributePropertyInputSelector = [], select_multiple: bool = False, ignore_self_and_children: bool = False)

Bases: StructBase

Helper struct for organizing queries against the world to gather actors.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGActorSelector.h

Editor Properties: (see get_editor_property/set_editor_property)

  • actor_filter (PCGActorFilter): [Read-Write] Which actors to consider.

  • actor_reference_selector (PCGAttributePropertyInputSelector): [Read-Write] Controls what attribute to read from when the actor selector uses the “FromInput” actor filter.

  • actor_selection (PCGActorSelection): [Read-Write] How to select when filtering actors.

  • actor_selection_class (type(Class)): [Read-Write] Actor class to match against when filtering actors.

  • actor_selection_tag (Name): [Read-Write] Tag to match against when filtering actors.

  • disable_filter (bool): [Read-Write] Enables/disables fine-grained actor filtering options.

  • ignore_self_and_children (bool): [Read-Write] If true, ignores results found from within this actor’s hierarchy.

  • include_children (bool): [Read-Write] Whether to consider child actors.

  • must_overlap_self (bool): [Read-Write] Filters out actors that do not overlap the source component bounds.

  • select_multiple (bool): [Read-Write] If true processes all matching actors, otherwise returns data from first match.

property actor_filter: PCGActorFilter

[Read-Write] Which actors to consider.

Type:

(PCGActorFilter)

property actor_reference_selector: PCGAttributePropertyInputSelector

[Read-Write] Controls what attribute to read from when the actor selector uses the “FromInput” actor filter.

Type:

(PCGAttributePropertyInputSelector)

property actor_selection: PCGActorSelection

[Read-Write] How to select when filtering actors.

Type:

(PCGActorSelection)

property actor_selection_class: Class

[Read-Write] Actor class to match against when filtering actors.

Type:

(type(Class))

property actor_selection_tag: Name

[Read-Write] Tag to match against when filtering actors.

Type:

(Name)

property disable_filter: bool

[Read-Write] Enables/disables fine-grained actor filtering options.

Type:

(bool)

property ignore_self_and_children: bool

[Read-Write] If true, ignores results found from within this actor’s hierarchy.

Type:

(bool)

property include_children: bool

[Read-Write] Whether to consider child actors.

Type:

(bool)

property must_overlap_self: bool

[Read-Write] Filters out actors that do not overlap the source component bounds.

Type:

(bool)

property select_multiple: bool

[Read-Write] If true processes all matching actors, otherwise returns data from first match.

Type:

(bool)