unreal.MovieGraphConditionGroup

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

Bases: Object

A group of queries which can be added to a collection.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphRenderLayerSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • op_type (MovieGraphConditionGroupOpType): [Read-Write] The operation type that the condition group is using.

  • queries (Array[MovieGraphConditionGroupQueryBase]): [Read-Write] The queries that are contained within the condition group.

add_query(query_type, insert_index=-1) → MovieGraphConditionGroupQueryBase

Adds a new condition group query to the condition group and returns a ptr to it. The condition group owns the created query. By default the query is added to the end, but an optional index can be provided if the query should be placed in a specific location among the existing queries.

Parameters:

  • query_type (type(Class)) –

  • insert_index (int32) –

Return type:

MovieGraphConditionGroupQueryBase

evaluate(world) → Set[Actor]

Determines the actors that match the condition group by running the queries contained in it.

Parameters:

world (World) –

Return type:

Set[Actor]

get_operation_type() → MovieGraphConditionGroupOpType

Gets the condition group operation type.

Return type:

MovieGraphConditionGroupOpType

get_queries() → Array[MovieGraphConditionGroupQueryBase]

Gets all queries currently contained in the condition group.

Return type:

Array[MovieGraphConditionGroupQueryBase]

is_first_condition_group() → bool

Determines if this is the first condition group under the parent collection.

Return type:

bool

move_query_to_index(query, new_index) → bool

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

Parameters:
Return type:

bool

remove_query(query) → bool

Removes the specified query from the condition group if it exists. Returns true on success, else false.

Parameters:

query (MovieGraphConditionGroupQueryBase) –

Return type:

bool

set_operation_type(operation_type) → None

Sets how the condition group interacts with the collection. This call is ignored for the first condition group in the collection (the first is always Union).

Parameters:

operation_type (MovieGraphConditionGroupOpType) –