Class Edge

constructor

• new Edge(
      a: Point,
      b: Point,
      options?: {
          direction?: WallDirection;
          id?: string;
          light?: WallSenseType;
          move?: WallSenseType;
          object?: PlaceableObject;
          priority?: number;
          sight?: WallSenseType;
          sound?: WallSenseType;
          threshold?: WallThresholdData;
          type?: EdgeType;
      },
  ): Edge

  Construct an Edge by providing the following information.

  Parameters

  • a: Point

    The first endpoint of the edge
  • b: Point

    The second endpoint of the edge
  • Optionaloptions: {
        direction?: WallDirection;
        id?: string;
        light?: WallSenseType;
        move?: WallSenseType;
        object?: PlaceableObject;
        priority?: number;
        sight?: WallSenseType;
        sound?: WallSenseType;
        threshold?: WallThresholdData;
        type?: EdgeType;
    } = {}

    Additional options which describe the edge

    • Optionaldirection?: WallDirection

      A direction of effect for the edge

    • Optionalid?: string

      A string used to uniquely identify this edge

    • Optionallight?: WallSenseType

      How this edge restricts light

    • Optionalmove?: WallSenseType

      How this edge restricts movement

    • Optionalobject?: PlaceableObject

      A PlaceableObject that is responsible for this edge, if any

    • Optionalpriority?: number

      A source priority for this edge. Typically zero unless this edge was contributed by a high-priority source.

    • Optionalsight?: WallSenseType

      How this edge restricts sight

    • Optionalsound?: WallSenseType

      How this edge restricts sound

    • Optionalthreshold?: WallThresholdData

      Configuration of threshold data for this edge

    • Optionaltype?: EdgeType

      The type of edge

  Returns Edge

a

b

bounds

direction

id

intersections

light

move

nw

se

sight

sound

threshold

vertexA

vertexB

applyThreshold

• applyThreshold(
      sourceType: string,
      sourceOrigin: Point,
      externalRadius?: number,
  ): boolean

  Test whether to apply a proximity threshold to this edge. If the proximity threshold is met, this edge excluded from perception calculations.

  Parameters

  • sourceType: string

    Sense type for the source
  • sourceOrigin: Point

    The origin or position of the source on the canvas
  • OptionalexternalRadius: number = 0

    The external radius of the source

  Returns boolean

  True if the edge has a threshold greater than 0 for the source type, and the source type is within that distance.

clone

• clone(): Edge

  Create a copy of the Edge which can be safely mutated.

  Returns Edge

getIntersection

• getIntersection(other: Edge): void | LineIntersection

  Get an intersection point between this Edge and another.

  Parameters

  • other: Edge

  Returns void | LineIntersection

isLimited

• isLimited(type: "light" | "sight" | "sound" | "move"): boolean

  Is this edge limited for a particular type?

  Parameters

  • type: "light" | "sight" | "sound" | "move"

  Returns boolean

orientPoint

• orientPoint(point: Point): number

  Determine the orientation of this Edge with respect to a reference point.

  Parameters

  • point: Point

    Some reference point, relative to which orientation is determined

  Returns number

  An orientation in CONST.WALL_DIRECTIONS which indicates whether the Point is left, right, or collinear (both) with the Edge

recordIntersections

• recordIntersections(other: Edge): void

  Record the intersections between two edges.

  Parameters

  • other: Edge

    Another edge to test and record

  Returns void

removeIntersections

• removeIntersections(): void

  Remove intersections of this edge with all other edges.

  Returns void

StaticidentifyEdgeIntersections

• identifyEdgeIntersections(edges: Iterable<Edge, any, any>): void

  Identify intersections between a provided iterable of edges.

  Parameters

  • edges: Iterable<Edge, any, any>

    An iterable of edges

  Returns void