Interface TokenAnimationContext

interface TokenAnimationContext {
    chain: {
        options: Omit<TokenAnimationOptions, "duration"> & { duration: number };
        promise: Promise<void>;
        reject: (error: Error) => void;
        resolve: () => void;
        to: Partial<TokenAnimationData>;
    }[];
    duration: number;
    name: string
    | symbol;
    onAnimate: (context: TokenAnimationContext) => void[];
    postAnimate: (context: TokenAnimationContext) => void[];
    preAnimate: (context: TokenAnimationContext) => Promise<void>[];
    promise: Promise<void>;
    time: number;
    to: Partial<TokenAnimationData>;
}

Properties

chain duration name onAnimate postAnimate preAnimate promise time to

Properties

chain

chain: {
    options: Omit<TokenAnimationOptions, "duration"> & { duration: number };
    promise: Promise<void>;
    reject: (error: Error) => void;
    resolve: () => void;
    to: Partial<TokenAnimationData>;
}[]

The animation chain.

duration

duration: number

The duration of the animation.

name

name: string | symbol

The name of the animation.

onAnimate

onAnimate: (context: TokenAnimationContext) => void[]

Synchronous functions that are executed each frame after ontick and before foundry.canvas.placeables.Token#_onAnimationUpdate.

postAnimate

postAnimate: (context: TokenAnimationContext) => void[]

Synchronous functions that are executed after the animation ended. They may be executed before the preAnimate functions have finished if the animation is terminated.

preAnimate

preAnimate: (context: TokenAnimationContext) => Promise<void>[]

Asynchronous functions that are executed before the animation starts

promise

promise: Promise<void>

The promise of the animation that resolves once it completes or is terminated.

time

time: number

The current time of the animation.

to

to: Partial<TokenAnimationData>

The final animation state.

Settings

Member Visibility

On This Page

Properties