unreal.AnimNotifyState_TimedNiagaraEffect

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

Bases: AnimNotifyState

Timed Niagara Effect Notify Allows a looping Niagara effect to be played in an animation that will activate at the beginning of the notify and deactivate at the end.

C++ Source:

• Plugin: Niagara

• Module: NiagaraAnimNotifies

• File: AnimNotifyState_TimedNiagaraEffect.h

Editor Properties: (see get_editor_property/set_editor_property)

• destroy_at_end (bool): [Read-Write] Whether the Niagara system should be immediately destroyed at the end of the notify state or be allowed to finish

• location_offset (Vector): [Read-Write] Offset from the socket or bone to place the Niagara system

• notify_color (Color): [Read-Write] Color of Notify in editor

• rotation_offset (Rotator): [Read-Write] Rotation offset from the socket or bone for the Niagara system

• should_fire_in_editor (bool): [Read-Write] Whether this notify state instance should fire in animation editors

• socket_name (Name): [Read-Write] The socket or bone to attach the system to

• template (NiagaraSystem): [Read-Write] The niagara system to spawn for the notify state

property destroy_at_end: bool

[Read-Only] Whether the Niagara system should be immediately destroyed at the end of the notify state or be allowed to finish

Type:

(bool)

get_spawned_effect(mesh_comp) → FXSystemComponent

Return FXSystemComponent created from SpawnEffect

Parameters:

mesh_comp (MeshComponent) –

Return type:

FXSystemComponent

property location_offset: Vector

[Read-Only] Offset from the socket or bone to place the Niagara system

Type:

(Vector)

property rotation_offset: Rotator

[Read-Only] Rotation offset from the socket or bone for the Niagara system

Type:

(Rotator)

property socket_name: Name

[Read-Only] The socket or bone to attach the system to

Type:

(Name)

property template: NiagaraSystem

[Read-Only] The niagara system to spawn for the notify state

Type:

(NiagaraSystem)