Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...
    interface CanvasAnimationOptions {
        context?: DisplayObject;
        duration?: number;
        easing?: CanvasAnimationEasingFunction;
        name?: string | symbol;
        ontick?: (elapsedMS: number, animation: CanvasAnimationData) => void;
        priority?: number;
        time?: number;
        wait?: Promise<any>;
    }
    Index

    Properties

    context?: DisplayObject

    A DisplayObject which defines context to the PIXI.Ticker function

    duration?: number

    A duration in milliseconds over which the animation should occur

    An easing function used to translate animation time or the string name of a static member of CanvasAnimation

    name?: string | symbol

    A unique name which can be used to reference the in-progress animation

    ontick?: (elapsedMS: number, animation: CanvasAnimationData) => void

    A callback function which fires after every frame

    priority?: number

    A priority in PIXI.UPDATE_PRIORITY which defines when the animation should be evaluated related to others

    time?: number

    The current time of the animation, in milliseconds

    wait?: Promise<any>

    The animation isn't started until this promise resolves