unreal.ContextualAnimSceneInstance

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

Bases: Object

Instance of a contextual animation scene

C++ Source:

• Plugin: ContextualAnimation

• Module: ContextualAnimation

• File: ContextualAnimSceneInstance.h

Editor Properties: (see get_editor_property/set_editor_property)

• on_actor_joined (OnContextualAnimSceneActorJoined): [Read-Write] Delegate to notify external objects when an actor join

• on_actor_left (OnContextualAnimSceneActorLeft): [Read-Write] Delegate to notify external objects when an actor leave

• on_notify_begin (OnContextualAnimSceneNotify): [Read-Write] Delegate to notify external objects when an animation hits a ‘PlayMontageNotify’ or ‘PlayMontageNotifyWindow’ begin

• on_notify_end (OnContextualAnimSceneNotify): [Read-Write] Delegate to notify external objects when an animation hits a ‘PlayMontageNotify’ or ‘PlayMontageNotifyWindow’ end

• on_scene_ended (OnContextualAnimSceneEnded): [Read-Write] Delegate to notify external objects when this is scene is completed after all montages played by the scene section blended out. Will not be broadcasted if one or more montages have ‘bEnableAutoBlendOut’ set to ‘false’.

• on_section_end_time_reached (OnContextualAnimSceneEnded): [Read-Write] Delegate to notify once the scene play time reaches the duration defined by the longest played montage of the selected section. This delegate should be used if one or more montages have ‘bEnableAutoBlendOut’ set to ‘false’.

get_actor_by_role(role) → Actor

Get Actor by Role

Parameters:

role (Name) –

Return type:

Actor

property on_actor_joined: OnContextualAnimSceneActorJoined

[Read-Write] Delegate to notify external objects when an actor join

Type:

(OnContextualAnimSceneActorJoined)

property on_actor_left: OnContextualAnimSceneActorLeft

[Read-Write] Delegate to notify external objects when an actor leave

Type:

(OnContextualAnimSceneActorLeft)

property on_notify_begin: OnContextualAnimSceneNotify

[Read-Write] Delegate to notify external objects when an animation hits a ‘PlayMontageNotify’ or ‘PlayMontageNotifyWindow’ begin

Type:

(OnContextualAnimSceneNotify)

property on_notify_end: OnContextualAnimSceneNotify

[Read-Write] Delegate to notify external objects when an animation hits a ‘PlayMontageNotify’ or ‘PlayMontageNotifyWindow’ end

Type:

(OnContextualAnimSceneNotify)

property on_scene_ended: OnContextualAnimSceneEnded

[Read-Write] Delegate to notify external objects when this is scene is completed after all montages played by the scene section blended out. Will not be broadcasted if one or more montages have ‘bEnableAutoBlendOut’ set to ‘false’.

Type:

(OnContextualAnimSceneEnded)

property on_section_end_time_reached: OnContextualAnimSceneEnded

[Read-Write] Delegate to notify once the scene play time reaches the duration defined by the longest played montage of the selected section. This delegate should be used if one or more montages have ‘bEnableAutoBlendOut’ set to ‘false’.

Type:

(OnContextualAnimSceneEnded)