Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface VFXScrollingTextData

    interface VFXScrollingTextData {
        content: string;
        distance?: number;
        duration: number;
        jitter: number;
        origin: { x: number; y: number };
        scrollDirection: number;
        textAnchor: number;
        textStyle: object;
    }
    Index

    Properties

    content distance? duration jitter origin scrollDirection textAnchor textStyle

    Properties

    content

    content: string

    The text string to display

    distance?: number

    The distance in pixels the text travels; defaults to twice the text size

    duration: number

    The duration of the scrolling effect in milliseconds (default 2000)

    jitter: number

    Randomization between [0, 1] applied to the initial position (default 0)

    origin: { x: number; y: number }

    The canvas point where the text originates

    scrollDirection: number

    The direction the text scrolls in CONST.TEXT_ANCHOR_POINTS (default TOP)

    textAnchor: number

    An anchor point in CONST.TEXT_ANCHOR_POINTS (default CENTER)

    textStyle: object

    Additional PIXI.TextStyle parameters applied to the text

    Settings

    Member Visibility

    On This Page

    Properties