unreal.MovieGraphCollection

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

Bases: Object

A group of actors generated by actor queries.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphRenderLayerSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • collection_name (str): [Read-Write] The display name of the collection, shown in the UI. Does not need to be unique across collections.

  • condition_groups (Array[MovieGraphConditionGroup]): [Read-Write] The condition groups that are contained within the collection.

add_condition_group() → MovieGraphConditionGroup

Adds a new condition group to the collection and returns a ptr to it. The collection owns the created condition group.

Return type:

MovieGraphConditionGroup

evaluate(world) → Set[Actor]

Gets matching actors by having condition groups evaluate themselves, and performing set operations on the condition group results (eg, union’ing condition group A and B).

Parameters:

world (World) –

Return type:

Set[Actor]

get_collection_name() → str

Gets the name of the collection as seen in the UI.

Return type:

str

get_condition_groups() → Array[MovieGraphConditionGroup]

Gets all condition groups currently contained in the collection.

Return type:

Array[MovieGraphConditionGroup]

move_condition_group_to_index(condition_group, new_index) → bool

Move the specified condition group to a new index within the collection. Returns false if the condition group was not found or the index specified is invalid, else true.

Parameters:
Return type:

bool

remove_condition_group(condition_group) → bool

Removes the specified condition group from the collection if it exists. Returns true on success, else false. Removes all child queries that belong to this group at the same time.

Parameters:

condition_group (MovieGraphConditionGroup) –

Return type:

bool

set_collection_name(name) → None

Sets the name of the collection as seen in the UI.

Parameters:

name (str) –