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

    Interface TokenResizingInstruction

    Resize the Token such that its center point remains (almost) unchanged. The center point might change slightly because the new (x, y) position is rounded.

    interface TokenResizingInstruction {
        autoRotate?: false;
        constrainOptions?: { ignoreCost: true; ignoreWalls: true };
        dimensions: Partial<
            Omit<TokenData & TokenMovementWaypoint, "x" | "y" | "elevation">,
        >;
        id?: string;
        measureOptions?: {};
        method?: TokenMovementMethod;
        planned?: boolean;
        showRuler?: false;
        split?: boolean;
        terrainOptions?: {};
    }
    Index

    Properties

    autoRotate? constrainOptions? dimensions id? measureOptions? method? planned? showRuler? split? terrainOptions?

    Properties

    autoRotate?: false

    Resizing never auto rotates.

    constrainOptions?: { ignoreCost: true; ignoreWalls: true }

    Resizing always ignores walls, surfaces and impassable terrain.

    dimensions: Partial<
        Omit<TokenData & TokenMovementWaypoint, "x" | "y" | "elevation">,
    >

    The new dimensions and additional data.

    id?: string

    The movement ID, which must be unique. Default: auto-generated.

    measureOptions?: {}

    Resizing doesn't cost anything.

    method?: TokenMovementMethod

    The method of movement. Default: TokenMovementOptions#method.

    planned?: boolean

    Don't start the movement yet? Default: TokenMovementOptions#planned.

    showRuler?: false

    Resizing never shows the ruler.

    split?: boolean

    Start a new subpath? Default: TokenMovementOptions#split.

    terrainOptions?: {}

    Resizing doesn't move through terrain.

    Settings

    Member Visibility

    On This Page

    Properties