webchalk-animate - v0.31.0
    Preparing search index...

    An object containing specific details about an animation's effect. Returned by AnimClip.getEffectDetails.

    interface AnimClipEffectDetails {
        category: EffectCategory;
        effectName: string;
        effectOptions: unknown[];
        presetEffectDefinition: Readonly<
            StripDuplicateMethodAutocompletion<
                {
                    defaultConfig?: Partial<unknown> & object;
                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                    immutableConfig?: Partial<unknown> & object;
                    buildFrameGenerators(
                        this: Readonly<
                            Pick<
                                AnimClip<
                                    (
                                        Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>
                                    ),
                                    AnimClipConfig,
                                >,
                                "computeTween",
                            >,
                        >,
                        ...effectOptions: unknown[],
                    ): EffectFrameGeneratorSet;
                },
            >,
        >;
    }
    Index

    Properties

    category: EffectCategory

    The category of the effect (e.g., "Entrance", "Exit", "Motion", etc.).

    effectName: string

    The name of the animation effect.

    effectOptions: unknown[]

    The array containing the effect options used to set the behavior of the animation effect.

    presetEffectDefinition: Readonly<
        StripDuplicateMethodAutocompletion<
            {
                defaultConfig?: Partial<unknown> & object;
                howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                immutableConfig?: Partial<unknown> & object;
                buildFrameGenerators(
                    this: Readonly<
                        Pick<
                            AnimClip<
                                (
                                    Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>
                                ),
                                AnimClipConfig,
                            >,
                            "computeTween",
                        >,
                    >,
                    ...effectOptions: unknown[],
                ): EffectFrameGeneratorSet;
            },
        >,
    >

    The object containing both the function used to build the effect frame generators and possibly a set of default configuration options for the effect.