unreal.AvaTransitionLibrary

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

Bases: BlueprintFunctionLibrary

Ava Transition Library

C++ Source:

  • Plugin: Avalanche

  • Module: AvalancheTransition

  • File: AvaTransitionLibrary.h

classmethod are_scenes_transitioning(context_object, layers, scenes_to_ignore) → bool

Determines whether there are scenes/levels (other than the one from this context) transitioning. Note: this ignores scenes that are transitioning out and to be discarded.

Parameters:

  • context_object (Object) – the context to retrieve the active transition relating to the context.

  • layers (AvaTagHandleContainer) – the layers to consider

  • scenes_to_ignore (Array[World]) – the world assets to ignore

Returns:

true if the given layers have assets that are involved in a transition.

Return type:

bool

classmethod get_transition_tree(context_object) → AvaTransitionTree

Retrieves the transition tree from this context

Parameters:

context_object (Object)

Return type:

AvaTransitionTree

classmethod get_transition_type(context_object) → AvaTransitionType

Returns the transition type of the current transition taking place if any

Parameters:

context_object (Object)

Return type:

AvaTransitionType

classmethod is_transition_active_in_layer(context_object, scene_comparison_type, layer_comparison_type, specific_layers) → bool

Is Transition Active in Layer deprecated: Use “IsTransitionActiveInLayers” instead

Parameters:
Return type:

bool

classmethod is_transition_active_in_layers(context_object, layer_comparison_type, specific_layers, transition_type_filter=AvaTransitionTypeFilter.ANY) → bool

Determines whether a transition is currently taking place at a given layer

Parameters:

  • context_object (Object) – the context to retrieve the active transition relating to the context.

  • layer_comparison_type (AvaTransitionLayerCompareType) – the type of layer to filter. “Same”: the same layer as this context’s. “Other”: a layer different from this context’s. “Specific Layers”: layers specified by “InSpecificLayers”. “Any”: any layer found.

  • specific_layers (AvaTagHandleContainer) – the specific layers to filter. InLayerComparisonType should be set to “Specific Layers” for this to be considered.

  • transition_type_filter (AvaTransitionTypeFilter) – the transition type to filter (whether it should only consider Ins or Outs, or any type is allowed)

Return type:

bool