ixfx
    Preparing search index...

    Function create

    • create(
          type: VisitorTypes,
          opts?: Partial<
              Readonly<
                  {
                      boundsWrap: Geometry.GridBoundsLogic;
                      debug: boolean;
                      reversed: boolean;
                      start: Geometry.GridCell;
                      visited: ISetMutable<Geometry.GridCell>;
                  },
              >,
          >,
      ): (
          grid: Geometry.Grid,
          optionsOverride?: Partial<
              Readonly<
                  {
                      boundsWrap: Geometry.GridBoundsLogic;
                      debug: boolean;
                      reversed: boolean;
                      start: Geometry.GridCell;
                      visited: ISetMutable<Geometry.GridCell>;
                  },
              >,
          >,
      ) => Generator<Geometry.GridCell, any, any>

      Logic types:

      • 'row': left-to-right, top-to-bottom
      • 'column': top-to-bottom, left-to-right
      • 'neighbours': neighbours surrounding cell (eight)
      • 'breadth`: breadth-first
      • 'depth': depth-first
      • 'random': any random cell in grid
      • 'random-contiguous': any random cell neighbouring an already visited cell

      Parameters

      Returns (
          grid: Geometry.Grid,
          optionsOverride?: Partial<
              Readonly<
                  {
                      boundsWrap: Geometry.GridBoundsLogic;
                      debug: boolean;
                      reversed: boolean;
                      start: Geometry.GridCell;
                      visited: ISetMutable<Geometry.GridCell>;
                  },
              >,
          >,
      ) => Generator<Geometry.GridCell, any, any>

    Settings

    Member Visibility