Skip to content

Documentation / scene / StopAnimationOptions

Type Alias: StopAnimationOptions

StopAnimationOptions = object

Defined in: libs/scene/src/animation/animationset.ts:155

Options for stopping an animation.

Allows a graceful fade-out instead of abrupt stop.

Properties

fadeOut?

optional fadeOut?: number

Defined in: libs/scene/src/animation/animationset.ts:162

Fade-out duration in seconds.

Interpolates the current animation weight down to 0 over this time. Default is 0 (immediate stop).


reason?

optional reason?: AnimationStopReason

Defined in: libs/scene/src/animation/animationset.ts:166

Stop reason reported by playback events.

Released under the MIT License.