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

    Class VFXReferencePointField

    A specialized subclass of VFXReferenceObjectField that specifically deals with points.

    const point = new VFXReferencePointField();
    const unresolvedValue = {reference: "target", deltas: {x: -50, y: 50}};
    const references = {target: tokenDocument}; // Suppose tokenDocument.x is 1000 and tokenDocument.y is 2000
    const resolvedObject = point.resolve(unresolvedValue, references); // {x: 950, y: 2050}

    Hierarchy (View Summary)

    Index

    Properties

    hierarchical recursive referenceField

    Accessors

    hasFormSupport _defaults

    Methods

    resolve isReference

    Properties

    hierarchical: boolean = false

    Whether this field defines part of a Document/Embedded Document hierarchy.

    recursive: boolean = false

    Does this field type contain other fields in a recursive structure? Examples of recursive fields are SchemaField, ArrayField, or TypeDataField Examples of non-recursive fields are StringField, NumberField, or ObjectField

    referenceField: SchemaField = ...

    Accessors

    • get hasFormSupport(): boolean

      Does this form field class have defined form support?

      Returns boolean

    Protected Static_defaults

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods