Class ClockworkPath

A path from a start position to an end position. Typically returned by a function like pathToFlowFieldOrigin rather than created directly.

Constructors

constructor

Accessors

length

Methods

[iterator] findNextIndex free get reversed toArray toArrayReversed

Constructors

constructor

Accessors

length

Methods

[iterator]

  • "[iterator]"(): { next: () => { done: boolean; value: RoomPosition } }

  • Iterate over the path.

    Returns { next: () => { done: boolean; value: RoomPosition } }

    Example

    for (const pos of path) {
      console.log(pos);
    }

findNextIndex

  • findNextIndex(pos: RoomPosition): undefined | number

  • Given a current position, find the index of the next position in the path.

    Parameters

    • pos: RoomPosition

    Returns undefined | number

free

get

  • get(index: number): RoomPosition

  • Get the position at a given index.

    Parameters

    • index: number

    Returns RoomPosition

reversed

  • reversed(): Generator<
        never,
        { next: () => { done: boolean; value: RoomPosition } },
        unknown,
    >

  • Iterate over the path in reverse order.

    Returns Generator<
        never,
        { next: () => { done: boolean; value: RoomPosition } },
        unknown,
    >

    Example

    for (const pos of path.reversed()) {
      console.log(pos);
    }

toArray

  • toArray(): RoomPosition[]

  • Convert the path to an array of positions.

    Returns RoomPosition[]

toArrayReversed

  • toArrayReversed(): RoomPosition[]

  • Convert the path to an array of positions in reverse order.

    Returns RoomPosition[]

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods