Class WangTileChunk<D, V>

A chunk is a block of the dimension which can be used to observe part of a tile generated world.

Type Parameters

D extends number[]
V extends WangTileSet<D> | WangTile<D> = WangTileSet<D> | WangTile<D>

Index

Constructors

constructor

new WangTileChunk<
    D extends number[],
    V extends
        WangTileSet<D, unknown> | WangTile<D, unknown> =
        | WangTileSet<D, unknown>
        | WangTile<D, unknown>,
>(
    tileset: Set<WangTile<D, unknown>>,
    random: RandomGenerator,
    chunkStart: D,
    chunkEnd: D,
): WangTileChunk<D, V>
Type Parameters
- D extends number[]
- V extends WangTileSet<D, unknown> | WangTile<D, unknown> = WangTileSet<D, unknown> | WangTile<D, unknown>
Parameters
- tileset: Set<WangTile<D, unknown>>
- random: RandomGenerator
- chunkStart: D
- chunkEnd: D
Returns WangTileChunk<D, V>
- Defined in packages/wang-tiles/src/lib/chunk.ts:21

Properties

observed

observed: boolean = false

`Private` `Readonly`coordMap

coordMap: CoordMap<D, V>

`Private` `Readonly`center

center: D

`Private` `Readonly`iter

iter: number

`Private`active

active: D | null = null

`Private` `Readonly`tileset

tileset: Set<WangTile<D, unknown>>

`Private` `Readonly`random

random: RandomGenerator

Methods

observe

observe(): Generator<[D, WangTile<D, unknown>], void, unknown>
Observe the tiles until there are no unobserved tiles.

Returns Generator<[D, WangTile<D, unknown>], void, unknown>

Yields
- Defined in packages/wang-tiles/src/lib/chunk.ts:44

toJSON

toJSON(): Record<string, V>
Convert coordinate map to a simple object for storage and testing.

Returns Record<string, V>
An object representing all coordinates in the map. Keys are comma delineated coordinates.
- Defined in packages/wang-tiles/src/lib/chunk.ts:327

debug

debug(): string
Convert coordinate map to an ascii representation. Only works for 2D chunks at the moment.

Returns string
An ascii based representation of the map.
- Defined in packages/wang-tiles/src/lib/chunk.ts:336

`Private`select

select(coord: D): [D, WangTile<D, unknown>]
Select an element via weighted random at the coordinates.
Parameters
- coord: D
  The coordinates to retrieve.
Returns [D, WangTile<D, unknown>]
the coordinate/tile pair that was set.
- Defined in packages/wang-tiles/src/lib/chunk.ts:77

`Private`findSmallestSet

findSmallestSet(): [D, WangTileSet<D, unknown>] | null
Find the smallest set in the coordinate map and return it, or null if no more sets exist.

Returns [D, WangTileSet<D, unknown>] | null
A coord/tileset pair or null
- Defined in packages/wang-tiles/src/lib/chunk.ts:98

`Private`getPossibilitiesCount

getPossibilitiesCount(coord: D): number
Get the number for possibilities for a coordinate via count.
Parameters
- coord: D
  The coordinate to calculate.
Returns number
the count of possibilities for a coordinate.
- Defined in packages/wang-tiles/src/lib/chunk.ts:123

`Private`reduceAll

reduceAll(): void
Reduce the possibilities of the entire chunk

Returns void
- Defined in packages/wang-tiles/src/lib/chunk.ts:154

`Private`reduce

reduce(coord: D): V
Reduce the possibilities to a single tile.
Parameters
- coord: D
  The coordinate to retrieve.
Returns V
A single, randomly selected tile from the set.
- Defined in packages/wang-tiles/src/lib/chunk.ts:167

`Private`reduceByNeighborEdge

reduceByNeighborEdge(
    tile: WangTile<D, unknown>,
    availableTiles: WangTileSet<D, unknown>,
    dimensions: number,
    dimension: number,
    offset: -1 | 1,
): WangTileSet<D, unknown>
Reduce a tileset by a neighboring tile.
Parameters
- tile: WangTile<D, unknown>
  The neighboring tile
- availableTiles: WangTileSet<D, unknown>
  The tileset to reduce
- dimensions: number
  The number of dimensions
- dimension: number
  The dimension of the edge
- offset: -1 | 1
  The offset from the position
Returns WangTileSet<D, unknown>
- A new tileset reduced by the neighboring tile.
- Defined in packages/wang-tiles/src/lib/chunk.ts:261

`Private`reduceByNeighborEdges

reduceByNeighborEdges(
    tiles: WangTileSet<D>,
    availableTiles: WangTileSet<D, unknown>,
    dimensions: number,
    dimension: number,
    offset: -1 | 1,
): WangTileSet<D, unknown>
Reduce a tileset by a neighboring tile.
Parameters
- tiles: WangTileSet<D>
  The neighboring tileset
- availableTiles: WangTileSet<D, unknown>
  The tileset to reduce
- dimensions: number
  The number of dimensions
- dimension: number
  The dimension of the edge
- offset: -1 | 1
  The offset from the position
Returns WangTileSet<D, unknown>
- A new tileset reduced by the neighboring tile.
- Defined in packages/wang-tiles/src/lib/chunk.ts:291

Class WangTileChunk<D, V>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WangTileChunk<D, V>

Properties

observed

Private ReadonlycoordMap

Private Readonlycenter

Private Readonlyiter

Privateactive

Private Readonlytileset

Private Readonlyrandom

Methods

observe

Returns Generator<[D, WangTile<D, unknown>], void, unknown>

Yields

toJSON

Returns Record<string, V>

debug

Returns string

Privateselect

Parameters

Returns [D, WangTile<D, unknown>]

PrivatefindSmallestSet

Returns [D, WangTileSet<D, unknown>] | null

PrivategetPossibilitiesCount

Parameters

Returns number

PrivatereduceAll

Returns void

Privatereduce

Parameters

Returns V

PrivatereduceByNeighborEdge

Parameters

Returns WangTileSet<D, unknown>

PrivatereduceByNeighborEdges

Parameters

Returns WangTileSet<D, unknown>

Settings

On This Page

`Private` `Readonly`coordMap

`Private` `Readonly`center

`Private` `Readonly`iter

`Private`active

`Private` `Readonly`tileset

`Private` `Readonly`random

`Private`select

`Private`findSmallestSet

`Private`getPossibilitiesCount

`Private`reduceAll

`Private`reduce

`Private`reduceByNeighborEdge

`Private`reduceByNeighborEdges