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

    Interface RegionPlacementOptions

    interface RegionPlacementOptions {
        allowEmpty?: boolean;
        allowRotation?: boolean;
        attachToToken?: boolean;
        create?: boolean;
        createOptions?: Partial<Omit<DatabaseCreateOperation, "parent">>;
    }
    Index

    Properties

    allowEmpty? allowRotation? attachToToken? create? createOptions?

    Properties

    allowEmpty?: boolean

    Create/return an empty Region if all shapes are skipped? Default: false.

    allowRotation?: boolean

    Allow rotation of the Region? Default: true.

    attachToToken?: boolean

    Attach the Region to Tokens? If true, the initial elevation range passed in data is relative to the attached Token. Default: false.

    create?: boolean

    Create the Region? If false, the preview document is returned. Default: true. Non-GMs cannot create Regions while the game is paused.

    createOptions?: Partial<Omit<DatabaseCreateOperation, "parent">>

    Optional creation options. By default the creation option controlObject is true.

    Settings

    Member Visibility

    On This Page

    Properties