AddFlashEffect Function

Animates given parts with a given flash effect during an active 3D animation editing session.

    AddFlashEffect(parts: [[[EvItem|canvas-envision-document-items.html#part-items]]][], effect: [[[EvAnimationFlashEffect|evanimationflasheffect-interface.html]]]): Promise<void>

Parameters

parts: EvItem[]: An array of Part item objects, one or more part items of a 3D model currently edited in an active 3D animation editing session that should be animated with the given flash effect.
effect: EvAnimationFlashEffect: An EvAnimationFlashEffect object, given settings of a flash effect that should be applied to the given part items during the active 3D animation editing session.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the given parts have been successfully animated with the given flash effect during the active 3D animation editing session.

Discussion

The function will throw an error if the 3D animation editing mode has not been activated.

28 April 2025