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

    Interface EdgeCreationOptions

    Additional options which describe the edge

    interface EdgeCreationOptions {
        darkness?: EdgeSenseType;
        direction?: EdgeDirection;
        id?: string;
        light?: EdgeSenseType;
        move?: EdgeSenseType;
        object?: Document<object, DocumentConstructionContext> | PlaceableObject;
        priority?: number;
        sight?: EdgeSenseType;
        sound?: EdgeSenseType;
        threshold?: EdgeThresholdData | null;
        type?: EdgeType;
    }
    Index

    Properties

    darkness? direction? id? light? move? object? priority? sight? sound? threshold? type?

    Properties

    darkness?: EdgeSenseType

    How this edge restricts darkness

    direction?: EdgeDirection

    A direction of effect for the edge

    id?: string

    A string used to uniquely identify this edge

    light?: EdgeSenseType

    How this edge restricts light

    move?: EdgeSenseType

    How this edge restricts movement

    object?: Document<object, DocumentConstructionContext> | PlaceableObject

    A Document/PlaceableObject that is responsible for this edge, if any

    priority?: number

    A source priority for this edge. Default: 0.

    sight?: EdgeSenseType

    How this edge restricts sight

    sound?: EdgeSenseType

    How this edge restricts sound

    threshold?: EdgeThresholdData | null

    Configuration of threshold data for this edge

    type?: EdgeType

    The type of edge

    Settings

    Member Visibility

    On This Page

    Properties