Class BSPDungeonBuilder<T>

DungeonGenerator creates a number of rooms, and then works to connect them.

Type parameters

T

Hierarchy

Builder<T>
- BSPDungeonBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new BSPDungeonBuilder(config: BSPDungeonOptions<T>): BSPDungeonBuilder

Overrides Builder.constructor
- Defined in generation/bsp-dungeon-builder.ts:129
Parameters
- config: BSPDungeonOptions<T>
Returns BSPDungeonBuilder

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

createRooms

createRooms(options: { maxHeight?: undefined | number; maxWidth?: undefined | number; minHeight: number; minWidth: number; padding?: undefined | number }): void

- Defined in generation/bsp-dungeon-builder.ts:183
Creates rooms given the current BSP Tree. Use the 'split' method first to generate areas, then call createRooms to generate rooms within those areas

Parameters
- options: { maxHeight?: undefined | number; maxWidth?: undefined | number; minHeight: number; minWidth: number; padding?: undefined | number }
  
  Options to create the rooms
  - Optional maxHeight?: undefined | number
    
    The maximum height of a generated room. Will never be taller than the BSP area.
  - Optional maxWidth?: undefined | number
    
    The maximum width of a generated room. Will never be wider than the BSP area.
  - minHeight: number
    
    The minimum height of a generated room.
  - minWidth: number
    
    The minimum width of a generated room.
  - Optional padding?: undefined | number
    
    Can pad the area to ensure rooms aren't against the boundaries. Default 0.
Returns void

createSimpleHallways

createSimpleHallways(): void

- Defined in generation/bsp-dungeon-builder.ts:237
Creates simple right angle hallways between existing rooms.

Returns void

BSPDungeon - Can be used for method chaining.

getHallways

getHallways(): Vector2[][]

- Defined in generation/bsp-dungeon-builder.ts:260
Returns a list of all hallways

Returns Vector2[][]

Vector2[][] - The hallways

getLeafNodes

getLeafNodes(): BSPDungeonNode[]

- Defined in generation/bsp-dungeon-builder.ts:145
Returns BSPDungeonNode[]

getMap

getMap(): Table<T>

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

Returns Table<T>
- Table

getRooms

getRooms(): Rect[]

- Defined in generation/bsp-dungeon-builder.ts:229
Gets all rooms created. These will each belong to a leaf node of the BSP Tree.

Returns Rect[]

Rect[] - A list of all rooms

getSnapshots

getSnapshots(): Table<T>[]

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

Returns Table<T>[]
- Table[]

splitByCount

splitByCount(count: number): void

- Defined in generation/bsp-dungeon-builder.ts:163
Splits the dungeon n times. A count of 1 would divide the dungeon in two, count of 2 divides it in 4, etc.

Parameters
- count: number
  
  number
Returns void

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

Generated using TypeDoc