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

    Interface PointSourcePolygonConfig

    interface PointSourcePolygonConfig {
        angle?: number;
        boundaryShapes?: (Rectangle | Polygon | Circle)[];
        boundingBox?: Rectangle;
        debug?: boolean;
        density?: number;
        hasLimitedAngle?: boolean;
        hasLimitedRadius?: boolean;
        level?: documents.Level;
        radius?: number;
        rotation?: number;
        source?: any;
        surfaceExposure?: ElevatedSurfaceExposureOptions;
        type: PointSourcePolygonType;
        useThreshold?: boolean;
    }
    Index

    Properties

    angle? boundaryShapes? boundingBox? debug? density? hasLimitedAngle? hasLimitedRadius? level? radius? rotation? source? surfaceExposure? type useThreshold?

    Properties

    angle?: number

    The angle of emission, if limited

    boundaryShapes?: (Rectangle | Polygon | Circle)[]

    Limiting polygon boundary shapes

    boundingBox?: Rectangle

    The computed bounding box for the polygon

    debug?: boolean

    Display debugging visualization and logging for the polygon

    density?: number

    The desired density of padding rays, a number per PI

    hasLimitedAngle?: boolean

    Does this polygon have a limited angle?

    hasLimitedRadius?: boolean

    Does this polygon have a limited radius?

    level?: documents.Level

    The Level the polygon is computed in. Defaults to the viewed Level.

    radius?: number

    A limited radius of the resulting polygon

    rotation?: number

    The direction of facing, required if the angle is limited

    source?: any

    The object (if any) that spawned this polygon.

    surfaceExposure?: ElevatedSurfaceExposureOptions

    Additional options passed through to surface exposure generator

    type: PointSourcePolygonType

    The type of polygon being computed

    useThreshold?: boolean

    Compute the polygon with threshold wall constraints applied

    Settings

    Member Visibility

    On This Page

    Properties