Class DrunkardsWalkBuilder<T>

Generator to perform a Drunkard's Walk

Type parameters

T

Hierarchy

Builder<T>
- DrunkardsWalkBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new DrunkardsWalkBuilder(config: DrunkardsWalkConfig<T>): DrunkardsWalkBuilder

Overrides Builder.constructor
- Defined in generation/drunkards-walk-builder.ts:23
Creates a new DrunkardsWalk Generator

Parameters
- config: DrunkardsWalkConfig<T>
  
  Generator Config
Returns DrunkardsWalkBuilder

Methods

clearSnapshots

clearSnapshots(): void

Inherited from Builder.clearSnapshots
- Defined in generation/builder.ts:53
Clear previously captured snapshots.

Returns void

copyFrom

copyFrom(table: Table<T>): void

Inherited from Builder.copyFrom
- Defined in generation/builder.ts:62
Sets the map values to match a given table. A shallow copy is made from the given table.

Parameters
- table: Table<T>
Returns void

getCoverage

getCoverage(): number

- Defined in generation/drunkards-walk-builder.ts:70
Returns # of walked tiles / # of total tiles.

Returns number

number - Between 0.0 and 1.0

getMap

getMap(): Table<T>

Inherited from Builder.getMap
- Defined in generation/builder.ts:30
Returns the internal map.

Returns Table<T>
- Table

getPaths

getPaths(): Vector2[][]

- Defined in generation/drunkards-walk-builder.ts:62
Returns a list of paths previously walked.

Returns Vector2[][]

Vector2[][]

getSnapshots

getSnapshots(): Table<T>[]

Inherited from Builder.getSnapshots
- Defined in generation/builder.ts:46
Returns previously captured snapshots.

Returns Table<T>[]
- Table[]

takeSnapshot

takeSnapshot(): void

Inherited from Builder.takeSnapshot
- Defined in generation/builder.ts:38
Takes a snapshot of the current map state. These can be retrieved through getSnapshots()

Returns void

walk

walk(config: { maxCoverage?: undefined | number; pathCount?: undefined | number; start?: Vector2; stepsMax: number; stepsMin: number }): Vector2[][]

- Defined in generation/drunkards-walk-builder.ts:91
Generate a path by walking a number of steps. Can be called multiple times to have the Drunkard 'jump' to a different spot.

Parameters
- config: { maxCoverage?: undefined | number; pathCount?: undefined | number; start?: Vector2; stepsMax: number; stepsMin: number }
  
  The walk configuration
  - Optional maxCoverage?: undefined | number
    
    number - Stops walking if this much of the map is explored. Range [0.0, 1.0], default 1.0
  - Optional pathCount?: undefined | number
  - Optional start?: Vector2
    
    Vector2 - The starting position. Default random.
  - stepsMax: number
    
    number - The maximum number of steps to take for each walk (exclusive)
  - stepsMin: number
    
    number - The minimum number of steps to take for each walk (inclusive)
Returns Vector2[][]

Vector2[][] - The paths walked

Generated using TypeDoc