unreal.UAnimNotifyLibrary

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

Bases: BlueprintFunctionLibrary

A library of commonly used functionality for Notifies, exposed to blueprint.

C++ Source:

  • Module: Engine

  • File: AnimNotifyLibrary.h

classmethod get_current_animation_notify_state_time(event_reference) float

Gets the current time in seconds relative to the start of the notify state, clamped to the range of the notify state

Parameters:

event_reference (AnimNotifyEventReference) – The event to inspect

Returns:

the current time in seconds relative to the start of the notify state, clamped to the range of the notify state

Return type:

float

classmethod get_current_animation_notify_state_time_ratio(event_reference) float

Gets the current time as a ratio (0 -> 1) relative to the start of the notify state

Parameters:

event_reference (AnimNotifyEventReference) – The event to inspect

Returns:

the current time as a ratio (0 -> 1) relative to the start of the notify state

Return type:

float

classmethod get_current_animation_time(event_reference) float

Get the current anim notify time in seconds for when this notify was fired

Parameters:

event_reference (AnimNotifyEventReference) – The event to inspect

Returns:

the time in seconds through the current animation for when this notify was fired

Return type:

float

classmethod get_current_animation_time_ratio(event_reference) float

Get the current anim notify time as a ratio (0 -> 1) through the animation for when this notify was fired

Parameters:

event_reference (AnimNotifyEventReference) – The event to inspect

Returns:

the time as a ratio (0 -> 1) through the animation for when this notify was fired

Return type:

float

classmethod notify_state_reached_end(event_reference) bool

Get whether the notify state reached the end (was not cancelled)

Parameters:

event_reference (AnimNotifyEventReference) – The event to inspect

Return type:

bool