unreal.MovieGraphConditionGroupQueryBase

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

Bases: Object

Base class that all condition group queries must inherit from.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphRenderLayerSubsystem.h

evaluate(actors_to_query, world) → Set[Actor]

Determines which of the provided actors (in the given world) match the query. Matches are added to OutMatchingActors. Note that this method will not be called if ShouldEvaluateComponents() returns true; EvaluateActorsAndComponents() will be called instead.

Parameters:
Returns:

out_matching_actors (Set[Actor]):

Return type:

Set[Actor]

evaluate_actors_and_components(actors_to_query, world) -> (out_matching_actors=Set[Actor], out_matching_components=Set[ActorComponent])

Similar to Evaluate(), but returns both actors and components if the query can match both. Note that this method will only be called if ShouldEvaluateComponents() returns true.

Parameters:
Returns:

out_matching_actors (Set[Actor]):

out_matching_components (Set[ActorComponent]):

Return type:

tuple

get_operation_type() → MovieGraphConditionGroupQueryOpType

Gets the condition group query operation type.

Return type:

MovieGraphConditionGroupQueryOpType

is_editor_only_query() → bool

Determines if this query is only respected when run within the editor. Used for providing a UI hint.

Return type:

bool

is_enabled() → bool

Determines if this query is enabled.

Return type:

bool

is_first_condition_group_query() → bool

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

Return type:

bool

set_enabled(enabled) → None

Sets whether this query is enabled.

Parameters:

enabled (bool)

set_operation_type(operation_type) → None

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

Parameters:

operation_type (MovieGraphConditionGroupQueryOpType)

should_evaluate_components() → bool

Determines if this query should additionally match components, rather than just matching actors. Off by default. If this returns true, then EvaluateActorsAndComponents() will be called during evaluation instead of Evaluate().

Return type:

bool

should_hide_property_names() → bool

Determines if the public properties on the query class will have their names hidden in the details panel. Returns false by default. Most query subclasses will only have one property and do not need to clutter the UI with the property name (eg, the “Actor Name” query only shows one text box with entries for the actor names, no need to show the property name).

Return type:

bool