The gamebox-dgen Reference Manual

Table of Contents

The gamebox-dgen Reference Manual

This is the gamebox-dgen Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:07:07 2020 GMT+0.

1 Introduction

gamebox-dgen

A procedural dungeon generation library.

Note: This is unmaintained. Please use dungen instead.

Overview

This library can be used to generate a random dungeon for use in game development.

Install

(ql:quickload :gamebox-dgen)

Usage

If you just want to generate the map data:

(box.dgen:make-stage)

If you want to preview the generated map, drawing it with unicode characters in your REPL:

(box.dgen:print-stage (box.dgen:make-stage))

The result will look something like this:

MAKE-STAGE takes several optional arguments to influence the generator.

:SEED specifies the random seed integer to use. This makes it possible to regenerate the same dungeon at a later time. If this is not specified, it will be chosen randomly.

:WIDTH specifies the width of the stage in cells.

:HEIGHT specifies the height of the stage in cells.

:CORRIDOR-WINDINESS specifies how windy corridors will be, as a range from 0.0 to 1.0. This has minimal effect for densely packed rooms - see :ROOM-DENSITY below to control this. Default value is 0.0.

:ROOM-DENSITY specifies how densely rooms should be packed in the stage, as a range from 0.1 (10%) to 1.0 (100%). Note: This is only an estimation. Default value is 0.65.

:ROOM-SIZE-MIN specifies the minimum size in cells the width or height of a room is allowed to be, within the range 3 to 99. Note: This should be supplied as an odd integer value, else it will be incremented by 1. Default value is 3.

:ROOM-SIZE-MAX specifies the maximum size in cells the width or height of a room is allowed to be, within the range ROOM-SIZE-MIN to 99. Note: This should be supplied as an odd integer value, else it will be incremented by 1. Default value is 11.

:DOOR-RATE specified the percentage of junctions that should be doors, as a range from 0.0 to 1.0. A junction is an intersection between a room and a corridor. Default value is 0.5.

All of the data you need to render a map is located in the GRID slot of the returned stage data object. This is an array of CELL objects, each having the following slots:

X: The X location in the map.

Y: The Y location in the map.

CARVED: Determines whether this cell is ground that can be walked upon.

REGION-ID: An integer representing the region. A region is a group of adjacent cells. Each room's cells are of the same REGION-ID. Likewise, a corridor between two rooms (or more, in the case of branching) is of the same REGION-ID. You can think of a REGION-ID as belonging to a set of cells as if it was flood-filled, stopping at junctions (what this library calls doors or whatever your game may define them as).

FEATURES: A list of symbols identifying a special cell property, if any. Currently, this can be one or more of the following:

• :JUNCTION: The cell joins 2 unique regions.
• :DOOR: A junction has a chance of becoming a door.
• :STAIRS-UP: The cell with an entrance staircase.
• :STAIRS-DOWN: The cell with an exit staircase.
• :ROOM: The cell is part of a room.
• :CORRIDOR: The cell is part of a corridor.
• :WALL: The cell is part of a wall.

License

Copyright © 2015-2018 Michael Fiano.

Licensed under the MIT License.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 gamebox-dgen

Maintainer

Michael Fiano <mail@michaelfiano.com>

Author

Michael Fiano <mail@michaelfiano.com>

Home Page

https://www.michaelfiano.com/projects/gamebox-dgen

Source Control

(:git "git@github.com:mfiano/gamebox-dgen.git")

Bug Tracker

https://github.com/mfiano/gamebox-dgen/issues

License

MIT

Description

A procedural dungeon generator.

Long Description

# gamebox-dgen

A procedural dungeon generation library.

Note: This is unmaintained. Please use [dungen](https://github.com/mfiano/dungen) instead.

## Overview

This library can be used to generate a random dungeon for use in game development.

## Install

“‘ lisp
(ql:quickload :gamebox-dgen)
“‘

## Usage

If you just want to generate the map data:

“‘ lisp
(box.dgen:make-stage)
“‘

If you want to preview the generated map, drawing it with unicode characters in your REPL:

“‘ lisp
(box.dgen:print-stage (box.dgen:make-stage))
“‘

The result will look something like this:


‘MAKE-STAGE‘ takes several optional arguments to influence the generator.

‘:SEED‘ specifies the random seed integer to use. This makes it possible to regenerate the same dungeon at a later time. If this is not specified, it will be chosen randomly.

‘:WIDTH‘ specifies the width of the stage in cells.

‘:HEIGHT‘ specifies the height of the stage in cells.

‘:CORRIDOR-WINDINESS‘ specifies how windy corridors will be, as a range from 0.0 to 1.0. This has minimal effect for densely packed rooms - see ‘:ROOM-DENSITY‘ below to control this. Default value is 0.0.

‘:ROOM-DENSITY‘ specifies how densely rooms should be packed in the stage, as a range from 0.1 (10%) to 1.0 (100%). Note: This is only an estimation. Default value is 0.65.

‘:ROOM-SIZE-MIN‘ specifies the minimum size in cells the width or height of a room is allowed to be, within the range 3 to 99. Note: This should be supplied as an odd integer value, else it will be incremented by 1. Default value is 3.

‘:ROOM-SIZE-MAX‘ specifies the maximum size in cells the width or height of a room is allowed to be, within the range ‘ROOM-SIZE-MIN‘ to 99. Note: This should be supplied as an odd integer value, else it will be incremented by 1. Default value is 11.

‘:DOOR-RATE‘ specified the percentage of junctions that should be doors, as a range from 0.0 to 1.0. A junction is an intersection between a room and a corridor. Default value is 0.5.

All of the data you need to render a map is located in the ‘GRID‘ slot of the returned stage data object. This is an array of ‘CELL‘ objects, each having the following slots:

‘X‘: The X location in the map.

‘Y‘: The Y location in the map.

‘CARVED‘: Determines whether this cell is ground that can be walked upon.

‘REGION-ID‘: An integer representing the region. A region is a group of adjacent cells. Each room’s cells are of the same ‘REGION-ID‘. Likewise, a corridor between two rooms (or more, in the case of branching) is of the same ‘REGION-ID‘. You can think of a ‘REGION-ID‘ as belonging to a set of cells as if it was flood-filled, stopping at junctions (what this library calls doors or whatever your game may define them as).

‘FEATURES‘: A list of symbols identifying a special cell property, if any. Currently, this can be one or more of the following:

* ‘:JUNCTION‘: The cell joins 2 unique regions.
* ‘:DOOR‘: A junction has a chance of becoming a door.
* ‘:STAIRS-UP‘: The cell with an entrance staircase.
* ‘:STAIRS-DOWN‘: The cell with an exit staircase.
* ‘:ROOM‘: The cell is part of a room.
* ‘:CORRIDOR‘: The cell is part of a corridor.
* ‘:WALL‘: The cell is part of a wall.

## License

Copyright © 2015-2018 [Michael Fiano](mailto:mail@michaelfiano.com).

Licensed under the MIT License.

Version

1.0.0

Dependencies

• alexandria
• graph
• cl-speedy-queue
• genie
• simple-logger

Source

gamebox-dgen.asd (file)

Components

• package.lisp (file)
• neighborhood.lisp (file)
• region.lisp (file)
• stage.lisp (file)
• cell.lisp (file)
• graph.lisp (file)
• corridor.lisp (file)
• room.lisp (file)
• junction.lisp (file)
• stairs.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 gamebox-dgen.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/gamebox-dgen-20190307-git/gamebox-dgen.asd

Systems

gamebox-dgen (system)

3.1.2 gamebox-dgen/package.lisp

Parent

gamebox-dgen (system)

Location

package.lisp

Packages

box.dgen

3.1.3 gamebox-dgen/neighborhood.lisp

Dependency

package.lisp (file)

Parent

gamebox-dgen (system)

Location

neighborhood.lisp

Internal Definitions

• %make-nh (function)
• cell-nh (function)
• collect (function)
• convolve (function)
• convolve-all (function)
• copy-extent (function)
• copy-nh (function)
• e (function)
• extent (structure)
• extent-maximum (function)
• (setf extent-maximum) (function)
• extent-minimum (function)
• (setf extent-minimum) (function)
• extent-p (function)
• layout (generic function)
• layout (method)
• layout (method)
• layout (method)
• layout (method)
• make-extent (function)
• make-nh (function)
• n (function)
• ne (function)
• nfilter (function)
• nh (structure)
• nh-extent (function)
• (setf nh-extent) (function)
• nh-map-fn (function)
• (setf nh-map-fn) (function)
• nh-p (function)
• nh-realize (function)
• nh-set-fn (function)
• (setf nh-set-fn) (function)
• nh-stage (function)
• (setf nh-stage) (function)
• nh-x (function)
• (setf nh-x) (function)
• nh-y (function)
• (setf nh-y) (function)
• nmap (function)
• nmap-default (function)
• nmap-horizontal (function)
• nmap-orthogonal (function)
• nmap-rect (function)
• nmap-short (macro)
• nmap-vertical (function)
• nref (function)
• nset-default (function)
• nset-horizontal (function)
• nset-orthogonal (function)
• nset-rect (function)
• nset-vertical (function)
• nsetp (function)
• nw (function)
• origin (function)
• process (function)
• s (function)
• se (function)
• stage-coords (function)
• sw (function)
• w (function)

3.1.4 gamebox-dgen/region.lisp

Dependency

neighborhood.lisp (file)

Parent

gamebox-dgen (system)

Location

region.lisp

Internal Definitions

• %make-region (function)
• *region* (special variable)
• cells (function)
• (setf cells) (function)
• copy-region (function)
• get-region (function)
• id (function)
• (setf id) (function)
• make-region (function)
• region (structure)
• region-p (function)
• regions-distinct-p (function)

3.1.5 gamebox-dgen/stage.lisp

Dependency

region.lisp (file)

Parent

gamebox-dgen (system)

Location

stage.lisp

Exported Definitions

• grid (method)
• height (method)
• make-stage (function)
• print-stage (function)
• seed (method)
• stage (class)
• width (method)

Internal Definitions

• %generator (method)
• (setf %generator) (method)
• %graphs (method)
• (setf %graphs) (method)
• build (function)
• corridor-windiness (method)
• (setf corridor-windiness) (method)
• dead-ends (method)
• (setf dead-ends) (method)
• door-rate (method)
• ensure-dimensions (function)
• generator (method)
• graphs (method)
• hollow-walls (method)
• make-grid (function)
• make-rng (function)
• regions (method)
• (setf regions) (method)
• room-density (method)
• room-size-max (method)
• room-size-min (method)
• stage-rooms (method)
• (setf stage-rooms) (method)
• validate (function)

3.1.6 gamebox-dgen/cell.lisp

Dependency

stage.lisp (file)

Parent

gamebox-dgen (system)

Location

cell.lisp

Exported Definitions

• carved (method)
• (setf carved) (method)
• cell (function)
• (setf cell) (function)
• cell (class)
• cell-index (function)
• region-id (method)
• (setf region-id) (method)
• x (method)
• y (method)

Internal Definitions

• add-feature (function)
• carve (function)
• distance (method)
• (setf distance) (method)
• features (method)
• (setf features) (method)
• featuresp (function)
• make-cell (function)
• remove-feature (function)
• stage-border-p (function)
• uncarve (function)
• valid-cell-p (function)

3.1.7 gamebox-dgen/graph.lisp

Dependency

cell.lisp (file)

Parent

gamebox-dgen (system)

Location

graph.lisp

Internal Definitions

• %make-graphs (function)
• connectable (function)
• (setf connectable) (function)
• connectable-edges (function)
• connectable-nodes (function)
• copy-graphs (function)
• final (function)
• (setf final) (function)
• get-graph (function)
• graphs (structure)
• graphs-p (function)
• make-connectable (function)
• make-graphs (function)
• make-mst (function)
• mst (function)
• (setf mst) (function)

3.1.8 gamebox-dgen/corridor.lisp

Dependency

graph.lisp (file)

Parent

gamebox-dgen (system)

Location

corridor.lisp

Internal Definitions

• carve-corridor (function)
• carve-direction (function)
• choose-uncarved (function)
• create-corridors (function)
• erode-dead-ends (function)
• erode-walls (function)
• filter-carvable (function)
• filter-dead-end (function)
• pick-cell (function)
• uncarve-dead-end (function)

3.1.9 gamebox-dgen/room.lisp

Dependency

corridor.lisp (file)

Parent

gamebox-dgen (system)

Location

room.lisp

Exported Definitions

• height (method)
• width (method)

Internal Definitions

• add-rooms (function)
• estimate-rooms (function)
• intersectsp (generic function)
• intersectsp (method)
• intersectsp (method)
• make-room (function)
• place-room (function)
• stage-room (class)
• x1 (method)
• x2 (method)
• y1 (method)
• y2 (method)

3.1.10 gamebox-dgen/junction.lisp

Dependency

room.lisp (file)

Parent

gamebox-dgen (system)

Location

junction.lisp

Internal Definitions

• adjacent-junction-p (function)
• carve-loops (function)
• carve-tree (function)
• connect (function)
• connect-regions (function)
• filter-connectable (function)
• make-junction (function)

3.1.11 gamebox-dgen/stairs.lisp

Dependency

junction.lisp (file)

Parent

gamebox-dgen (system)

Location

stairs.lisp

Internal Definitions

• choose-downstairs (function)
• choose-upstairs (function)
• create-stairs (function)
• make-downstairs (function)
• make-upstairs (function)
• staircase-suitable-p (function)

4 Packages

Packages are listed by definition order.

4.1 box.dgen

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• carved (generic function)
• carved (method)
• (setf carved) (method)
• (setf carved) (generic function)
• cell (function)
• (setf cell) (function)
• cell (class)
• cell-index (function)
• grid (generic function)
• grid (method)
• height (generic function)
• height (method)
• height (method)
• make-stage (function)
• print-stage (function)
• region-id (generic function)
• region-id (method)
• (setf region-id) (method)
• (setf region-id) (generic function)
• seed (generic function)
• seed (method)
• stage (class)
• width (generic function)
• width (method)
• width (method)
• x (generic function)
• x (method)
• y (generic function)
• y (method)

Internal Definitions

• %generator (generic function)
• %generator (method)
• (setf %generator) (method)
• (setf %generator) (generic function)
• %graphs (generic function)
• %graphs (method)
• (setf %graphs) (method)
• (setf %graphs) (generic function)
• %make-graphs (function)
• %make-nh (function)
• %make-region (function)
• *region* (special variable)
• add-feature (function)
• add-rooms (function)
• adjacent-junction-p (function)
• build (function)
• carve (function)
• carve-corridor (function)
• carve-direction (function)
• carve-loops (function)
• carve-tree (function)
• cell-nh (function)
• cells (function)
• (setf cells) (function)
• choose-downstairs (function)
• choose-uncarved (function)
• choose-upstairs (function)
• collect (function)
• connect (function)
• connect-regions (function)
• connectable (function)
• (setf connectable) (function)
• connectable-edges (function)
• connectable-nodes (function)
• convolve (function)
• convolve-all (function)
• copy-extent (function)
• copy-graphs (function)
• copy-nh (function)
• copy-region (function)
• corridor-windiness (generic function)
• corridor-windiness (method)
• (setf corridor-windiness) (method)
• (setf corridor-windiness) (generic function)
• create-corridors (function)
• create-stairs (function)
• dead-ends (generic function)
• dead-ends (method)
• (setf dead-ends) (method)
• (setf dead-ends) (generic function)
• distance (generic function)
• distance (method)
• (setf distance) (method)
• (setf distance) (generic function)
• door-rate (generic function)
• door-rate (method)
• e (function)
• ensure-dimensions (function)
• erode-dead-ends (function)
• erode-walls (function)
• estimate-rooms (function)
• extent (structure)
• extent-maximum (function)
• (setf extent-maximum) (function)
• extent-minimum (function)
• (setf extent-minimum) (function)
• extent-p (function)
• features (generic function)
• features (method)
• (setf features) (method)
• (setf features) (generic function)
• featuresp (function)
• filter-carvable (function)
• filter-connectable (function)
• filter-dead-end (function)
• final (function)
• (setf final) (function)
• generator (generic function)
• generator (method)
• get-graph (function)
• get-region (function)
• graphs (generic function)
• graphs (method)
• graphs (structure)
• graphs-p (function)
• hollow-walls (generic function)
• hollow-walls (method)
• id (function)
• (setf id) (function)
• intersectsp (generic function)
• intersectsp (method)
• intersectsp (method)
• layout (generic function)
• layout (method)
• layout (method)
• layout (method)
• layout (method)
• make-cell (function)
• make-connectable (function)
• make-downstairs (function)
• make-extent (function)
• make-graphs (function)
• make-grid (function)
• make-junction (function)
• make-mst (function)
• make-nh (function)
• make-region (function)
• make-rng (function)
• make-room (function)
• make-upstairs (function)
• mst (function)
• (setf mst) (function)
• n (function)
• ne (function)
• nfilter (function)
• nh (structure)
• nh-extent (function)
• (setf nh-extent) (function)
• nh-map-fn (function)
• (setf nh-map-fn) (function)
• nh-p (function)
• nh-realize (function)
• nh-set-fn (function)
• (setf nh-set-fn) (function)
• nh-stage (function)
• (setf nh-stage) (function)
• nh-x (function)
• (setf nh-x) (function)
• nh-y (function)
• (setf nh-y) (function)
• nmap (function)
• nmap-default (function)
• nmap-horizontal (function)
• nmap-orthogonal (function)
• nmap-rect (function)
• nmap-short (macro)
• nmap-vertical (function)
• nref (function)
• nset-default (function)
• nset-horizontal (function)
• nset-orthogonal (function)
• nset-rect (function)
• nset-vertical (function)
• nsetp (function)
• nw (function)
• origin (function)
• pick-cell (function)
• place-room (function)
• process (function)
• region (structure)
• region-p (function)
• regions (generic function)
• regions (method)
• (setf regions) (method)
• (setf regions) (generic function)
• regions-distinct-p (function)
• remove-feature (function)
• room-density (generic function)
• room-density (method)
• room-size-max (generic function)
• room-size-max (method)
• room-size-min (generic function)
• room-size-min (method)
• s (function)
• se (function)
• stage-border-p (function)
• stage-coords (function)
• stage-room (class)
• stage-rooms (generic function)
• stage-rooms (method)
• (setf stage-rooms) (method)
• (setf stage-rooms) (generic function)
• staircase-suitable-p (function)
• sw (function)
• uncarve (function)
• uncarve-dead-end (function)
• valid-cell-p (function)
• validate (function)
• w (function)
• x1 (generic function)
• x1 (method)
• x2 (generic function)
• x2 (method)
• y1 (generic function)
• y1 (method)
• y2 (generic function)
• y2 (method)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: cell STAGE X Y

Get a cell in STAGE using the coordinates X and Y.

Package

box.dgen

Source

cell.lisp (file)

Writer

(setf cell) (function)

Function: (setf cell) VALUE STAGE X Y

Set a cell in STAGE to VALUE at the coordinates given by X and Y.

Package

box.dgen

Source

cell.lisp (file)

Reader

cell (function)

Function: cell-index STAGE CELL

Get the cell index in STAGE, given the cell object, CELL.

Package

box.dgen

Source

cell.lisp (file)

Function: make-stage &rest ATTRS

Generate the stage.

Accepts several optional arguments to influence the generator:

:SEED specifies the random seed integer to use. This makes it possible to regenerate the same dungeon at a later time. If this is not specified, it will be chosen randomly.

:WIDTH specifies the width of the stage in cells.

:HEIGHT specifies the height of the stage in cells.

:CORRIDOR-WINDINESS specifies how windy corridors will be, as a range from 0.0 to 1.0. This has minimal effect for densely packed rooms - see :ROOM-DENSITY below to control this. Default value is 0.0.

:ROOM-DENSITY specifies how densely rooms should be packed in the stage, as a range from 0.1 (10%) to 1.0 (100%). Note: This is only an estimation. Default value is 0.65.

:ROOM-SIZE-MIN specifies the minimum size in cells the width or height of a room is allowed to be, within the range 3 to 99. Note: This should be supplied as an odd integer value, else it will be incremented by 1. Default value is 3.

:ROOM-SIZE-MAX specifies the maximum size in cells the width or height of a room is allowed to be, within the range ROOM-SIZE-MIN to 99. Note: This should be supplied as an odd integer value, else it will be incremented by 1. Default value is 11.

:DOOR-RATE specified the percentage of junctions that should be doors, as a range from 0.0 to 1.0. A junction is an intersection between a room and a corridor. Default value is 0.5.

Package

box.dgen

Source

stage.lisp (file)

Function: print-stage STAGE

Print the generated stage using Unicode line drawing characters.

Package

box.dgen

Source

stage.lisp (file)

5.1.2 Generic functions

Generic Function: carved OBJECT

Generic Function: (setf carved) NEW-VALUE OBJECT

Package

box.dgen

Methods

Method: carved (CELL cell)

automatically generated reader method

Source

cell.lisp (file)

Method: (setf carved) NEW-VALUE (CELL cell)

automatically generated writer method

Source

cell.lisp (file)

Generic Function: grid OBJECT

Package

box.dgen

Methods

Method: grid (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: height OBJECT

Package

box.dgen

Methods

Method: height (STAGE-ROOM stage-room)

automatically generated reader method

Source

room.lisp (file)

Method: height (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: region-id OBJECT

Generic Function: (setf region-id) NEW-VALUE OBJECT

Package

box.dgen

Methods

Method: region-id (CELL cell)

automatically generated reader method

Source

cell.lisp (file)

Method: (setf region-id) NEW-VALUE (CELL cell)

automatically generated writer method

Source

cell.lisp (file)

Generic Function: seed OBJECT

Package

box.dgen

Methods

Method: seed (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: width OBJECT

Package

box.dgen

Methods

Method: width (STAGE-ROOM stage-room)

automatically generated reader method

Source

room.lisp (file)

Method: width (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: x OBJECT

Package

box.dgen

Methods

Method: x (CELL cell)

automatically generated reader method

Source

cell.lisp (file)

Generic Function: y OBJECT

Package

box.dgen

Methods

Method: y (CELL cell)

automatically generated reader method

Source

cell.lisp (file)

5.1.3 Classes

Class: cell ()

A cell represents a single unit in the stage grid which can contain various features.

Package

box.dgen

Source

cell.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• distance (method)
• distance (method)
• features (method)
• features (method)
• region-id (method)
• region-id (method)
• carved (method)
• carved (method)
• y (method)
• x (method)

Direct slots

Slot: %x

Initargs

:x

Readers

x (generic function)

Slot: %y

Initargs

:y

Readers

y (generic function)

Slot: %carved

Readers

carved (generic function)

Writers

(setf carved) (generic function)

Slot: %region-id

Readers

region-id (generic function)

Writers

(setf region-id) (generic function)

Slot: %features

Initform

(quote (:wall))

Readers

features (generic function)

Writers

(setf features) (generic function)

Slot: %distance

Initform

-1

Readers

distance (generic function)

Writers

(setf distance) (generic function)

Class: stage ()

A stage represents the generated grid of cells and the data used to render it.

Package

box.dgen

Source

stage.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• intersectsp (method)
• dead-ends (method)
• dead-ends (method)
• stage-rooms (method)
• stage-rooms (method)
• hollow-walls (method)
• door-rate (method)
• room-density (method)
• room-size-max (method)
• room-size-min (method)
• corridor-windiness (method)
• corridor-windiness (method)
• %graphs (method)
• graphs (method)
• %graphs (method)
• regions (method)
• regions (method)
• seed (method)
• %generator (method)
• generator (method)
• %generator (method)
• grid (method)
• height (method)
• width (method)

Direct slots

Slot: %width

Initargs

:width

Initform

49

Readers

width (generic function)

Slot: %height

Initargs

:height

Initform

49

Readers

height (generic function)

Slot: %grid

Readers

grid (generic function)

Slot: %generator

Readers

• %generator (generic function)
• generator (generic function)

Writers

(setf %generator) (generic function)

Slot: %seed

Initargs

:seed

Initform

(genie:make-seed)

Readers

seed (generic function)

Slot: %regions

Initform

(make-hash-table)

Readers

regions (generic function)

Writers

(setf regions) (generic function)

Slot: %graphs

Readers

• %graphs (generic function)
• graphs (generic function)

Writers

(setf %graphs) (generic function)

Slot: %corridor-windiness

Initargs

:corridor-windiness

Initform

0

Readers

corridor-windiness (generic function)

Writers

(setf corridor-windiness) (generic function)

Slot: %room-size-min

Initargs

:room-size-min

Initform

3

Readers

room-size-min (generic function)

Slot: %room-size-max

Initargs

:room-size-max

Initform

11

Readers

room-size-max (generic function)

Slot: %room-density

Initargs

:room-density

Initform

0.65

Readers

room-density (generic function)

Slot: %door-rate

Initargs

:door-rate

Initform

0.5

Readers

door-rate (generic function)

Slot: %hollow-walls

Initargs

:hollow-walls

Readers

hollow-walls (generic function)

Slot: %rooms

Readers

stage-rooms (generic function)

Writers

(setf stage-rooms) (generic function)

Slot: %dead-ends

Readers

dead-ends (generic function)

Writers

(setf dead-ends) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *region*

Package

box.dgen

Source

region.lisp (file)

5.2.2 Macros

Macro: nmap-short NH FUNC REDUCE &key TEST RETURN-VAL

Package

box.dgen

Source

neighborhood.lisp (file)

5.2.3 Functions

Function: %make-graphs &key (CONNECTABLE CONNECTABLE) (MST MST) (FINAL FINAL)

Package

box.dgen

Source

graph.lisp (file)

Function: %make-nh &key (STAGE STAGE) (X X) (Y Y) (EXTENT EXTENT) (SET-FN SET-FN) (MAP-FN MAP-FN)

Package

box.dgen

Source

neighborhood.lisp (file)

Function: %make-region ID

Package

box.dgen

Source

region.lisp (file)

Function: add-feature CELL FEATURE

Package

box.dgen

Source

cell.lisp (file)

Function: add-rooms STAGE

Package

box.dgen

Source

room.lisp (file)

Function: adjacent-junction-p STAGE CELL

Package

box.dgen

Source

junction.lisp (file)

Function: build STAGE

Package

box.dgen

Source

stage.lisp (file)

Function: carve STAGE CELL &key REGION-ID FEATURE

Package

box.dgen

Source

cell.lisp (file)

Function: carve-corridor STAGE NH

Package

box.dgen

Source

corridor.lisp (file)

Function: carve-direction STAGE ORIGIN CELLS

Package

box.dgen

Source

corridor.lisp (file)

Function: carve-loops STAGE CONNECTIONS

Package

box.dgen

Source

junction.lisp (file)

Function: carve-tree STAGE CONNECTIONS

Package

box.dgen

Source

junction.lisp (file)

Function: cell-nh STAGE CELL LAYOUT

Package

box.dgen

Source

neighborhood.lisp (file)

Function: cells INSTANCE

Function: (setf cells) VALUE INSTANCE

Package

box.dgen

Source

region.lisp (file)

Function: choose-downstairs STAGE REGION-ID

Package

box.dgen

Source

stairs.lisp (file)

Function: choose-uncarved STAGE NH

Package

box.dgen

Source

corridor.lisp (file)

Function: choose-upstairs STAGE

Package

box.dgen

Source

stairs.lisp (file)

Function: collect STAGE LAYOUT FILTER &rest ARGS &key X1 X2 Y1 Y2

Package

box.dgen

Source

neighborhood.lisp (file)

Function: connect CONNECTIONS

Package

box.dgen

Source

junction.lisp (file)

Function: connect-regions STAGE

Package

box.dgen

Source

junction.lisp (file)

Function: connectable INSTANCE

Function: (setf connectable) VALUE INSTANCE

Package

box.dgen

Source

graph.lisp (file)

Function: connectable-edges CONNECTIONS

Package

box.dgen

Source

graph.lisp (file)

Function: connectable-nodes ()

Package

box.dgen

Source

graph.lisp (file)

Function: convolve STAGE LAYOUT FILTER EFFECT &key X1 X2 Y1 Y2

Package

box.dgen

Source

neighborhood.lisp (file)

Function: convolve-all STAGE EFFECT

Package

box.dgen

Source

neighborhood.lisp (file)

Function: copy-extent INSTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: copy-graphs INSTANCE

Package

box.dgen

Source

graph.lisp (file)

Function: copy-nh INSTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: copy-region INSTANCE

Package

box.dgen

Source

region.lisp (file)

Function: create-corridors STAGE

Package

box.dgen

Source

corridor.lisp (file)

Function: create-stairs STAGE

Package

box.dgen

Source

stairs.lisp (file)

Function: e NH &optional DISTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: ensure-dimensions STAGE

Package

box.dgen

Source

stage.lisp (file)

Function: erode-dead-ends STAGE

Package

box.dgen

Source

corridor.lisp (file)

Function: erode-walls STAGE

Package

box.dgen

Source

corridor.lisp (file)

Function: estimate-rooms STAGE

Package

box.dgen

Source

room.lisp (file)

Function: extent-maximum INSTANCE

Function: (setf extent-maximum) VALUE INSTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: extent-minimum INSTANCE

Function: (setf extent-minimum) VALUE INSTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: extent-p OBJECT

Package

box.dgen

Source

neighborhood.lisp (file)

Function: featuresp CELL &rest FEATURES

Package

box.dgen

Source

cell.lisp (file)

Function: filter-carvable STAGE NH

Package

box.dgen

Source

corridor.lisp (file)

Function: filter-connectable STAGE NH

Package

box.dgen

Source

junction.lisp (file)

Function: filter-dead-end STAGE NH

Package

box.dgen

Source

corridor.lisp (file)

Function: final INSTANCE

Function: (setf final) VALUE INSTANCE

Package

box.dgen

Source

graph.lisp (file)

Function: get-graph STAGE TYPE

Package

box.dgen

Source

graph.lisp (file)

Function: get-region STAGE ID

Package

box.dgen

Source

region.lisp (file)

Function: graphs-p OBJECT

Package

box.dgen

Source

graph.lisp (file)

Function: id INSTANCE

Function: (setf id) VALUE INSTANCE

Package

box.dgen

Source

region.lisp (file)

Function: make-cell STAGE X Y

Package

box.dgen

Source

cell.lisp (file)

Function: make-connectable CONNECTIONS

Package

box.dgen

Source

graph.lisp (file)

Function: make-downstairs STAGE SOURCE

Package

box.dgen

Source

stairs.lisp (file)

Function: make-extent &key (MINIMUM MINIMUM) (MAXIMUM MAXIMUM)

Package

box.dgen

Source

neighborhood.lisp (file)

Function: make-graphs STAGE CONNECTIONS

Package

box.dgen

Source

graph.lisp (file)

Function: make-grid STAGE

Package

box.dgen

Source

stage.lisp (file)

Function: make-junction STAGE CELL

Package

box.dgen

Source

junction.lisp (file)

Function: make-mst STAGE CONNECTABLE

Package

box.dgen

Source

graph.lisp (file)

Function: make-nh SET-FN MAP-FN EXTENT-ARGS

Package

box.dgen

Source

neighborhood.lisp (file)

Function: make-region STAGE

Package

box.dgen

Source

region.lisp (file)

Function: make-rng STAGE

Package

box.dgen

Source

stage.lisp (file)

Function: make-room STAGE

Package

box.dgen

Source

room.lisp (file)

Function: make-upstairs STAGE

Package

box.dgen

Source

stairs.lisp (file)

Function: mst INSTANCE

Function: (setf mst) VALUE INSTANCE

Package

box.dgen

Source

graph.lisp (file)

Function: n NH &optional DISTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: ne NH &optional DISTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nfilter NH FILTER

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nh-extent INSTANCE

Function: (setf nh-extent) VALUE INSTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nh-map-fn INSTANCE

Function: (setf nh-map-fn) VALUE INSTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nh-p OBJECT

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nh-realize NH-GENERATOR STAGE X Y

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nh-set-fn INSTANCE

Function: (setf nh-set-fn) VALUE INSTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nh-stage INSTANCE

Function: (setf nh-stage) VALUE INSTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nh-x INSTANCE

Function: (setf nh-x) VALUE INSTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nh-y INSTANCE

Function: (setf nh-y) VALUE INSTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nmap NH FUNC &rest ARGS

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nmap-default NH FUNC

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nmap-horizontal NH FUNC

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nmap-orthogonal NH FUNC

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nmap-rect NH FUNC

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nmap-vertical NH FUNC

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nref NH X Y

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nset-default NH X Y

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nset-horizontal NH X Y

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nset-orthogonal NH X Y

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nset-rect NH X Y

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nset-vertical NH X Y

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nsetp NH X Y

Package

box.dgen

Source

neighborhood.lisp (file)

Function: nw NH &optional DISTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: origin NH

Package

box.dgen

Source

neighborhood.lisp (file)

Function: pick-cell STAGE CELLS

Package

box.dgen

Source

corridor.lisp (file)

Function: place-room STAGE ROOM

Package

box.dgen

Source

room.lisp (file)

Function: process STAGE LAYOUT FILTER PROCESSOR &key ITEMS NH-GENERATOR

Package

box.dgen

Source

neighborhood.lisp (file)

Function: region-p OBJECT

Package

box.dgen

Source

region.lisp (file)

Function: regions-distinct-p N1 N2

Package

box.dgen

Source

region.lisp (file)

Function: remove-feature CELL FEATURE

Package

box.dgen

Source

cell.lisp (file)

Function: s NH &optional DISTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: se NH &optional DISTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: stage-border-p STAGE CELL

Package

box.dgen

Source

cell.lisp (file)

Function: stage-coords NH X Y

Package

box.dgen

Source

neighborhood.lisp (file)

Function: staircase-suitable-p STAGE NH

Package

box.dgen

Source

stairs.lisp (file)

Function: sw NH &optional DISTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

Function: uncarve STAGE CELL

Package

box.dgen

Source

cell.lisp (file)

Function: uncarve-dead-end STAGE NH

Package

box.dgen

Source

corridor.lisp (file)

Function: valid-cell-p STAGE X Y

Package

box.dgen

Source

cell.lisp (file)

Function: validate STAGE

Package

box.dgen

Source

stage.lisp (file)

Function: w NH &optional DISTANCE

Package

box.dgen

Source

neighborhood.lisp (file)

5.2.4 Generic functions

Generic Function: %generator OBJECT

Generic Function: (setf %generator) NEW-VALUE OBJECT

Package

box.dgen

Methods

Method: %generator (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Method: (setf %generator) NEW-VALUE (STAGE stage)

automatically generated writer method

Source

stage.lisp (file)

Generic Function: %graphs OBJECT

Generic Function: (setf %graphs) NEW-VALUE OBJECT

Package

box.dgen

Methods

Method: %graphs (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Method: (setf %graphs) NEW-VALUE (STAGE stage)

automatically generated writer method

Source

stage.lisp (file)

Generic Function: corridor-windiness OBJECT

Generic Function: (setf corridor-windiness) NEW-VALUE OBJECT

Package

box.dgen

Methods

Method: corridor-windiness (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Method: (setf corridor-windiness) NEW-VALUE (STAGE stage)

automatically generated writer method

Source

stage.lisp (file)

Generic Function: dead-ends OBJECT

Generic Function: (setf dead-ends) NEW-VALUE OBJECT

Package

box.dgen

Methods

Method: dead-ends (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Method: (setf dead-ends) NEW-VALUE (STAGE stage)

automatically generated writer method

Source

stage.lisp (file)

Generic Function: distance OBJECT

Generic Function: (setf distance) NEW-VALUE OBJECT

Package

box.dgen

Methods

Method: distance (CELL cell)

automatically generated reader method

Source

cell.lisp (file)

Method: (setf distance) NEW-VALUE (CELL cell)

automatically generated writer method

Source

cell.lisp (file)

Generic Function: door-rate OBJECT

Package

box.dgen

Methods

Method: door-rate (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: features OBJECT

Generic Function: (setf features) NEW-VALUE OBJECT

Package

box.dgen

Methods

Method: features (CELL cell)

automatically generated reader method

Source

cell.lisp (file)

Method: (setf features) NEW-VALUE (CELL cell)

automatically generated writer method

Source

cell.lisp (file)

Generic Function: generator OBJECT

Package

box.dgen

Methods

Method: generator (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: graphs OBJECT

Package

box.dgen

Methods

Method: graphs (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: hollow-walls OBJECT

Package

box.dgen

Methods

Method: hollow-walls (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: intersectsp SOURCE TARGET

Package

box.dgen

Source

room.lisp (file)

Methods

Method: intersectsp (SOURCE stage-room) (TARGET stage)

Method: intersectsp (SOURCE stage-room) (TARGET stage-room)

Generic Function: layout NAME &rest EXTENT-ARGS

Package

box.dgen

Source

neighborhood.lisp (file)

Methods

Method: layout (NAME (eql rect)) &rest EXTENT-ARGS

Method: layout (NAME (eql orthogonal)) &rest EXTENT-ARGS

Method: layout (NAME (eql vertical)) &rest EXTENT-ARGS

Method: layout (NAME (eql horizontal)) &rest EXTENT-ARGS

Generic Function: regions OBJECT

Generic Function: (setf regions) NEW-VALUE OBJECT

Package

box.dgen

Methods

Method: regions (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Method: (setf regions) NEW-VALUE (STAGE stage)

automatically generated writer method

Source

stage.lisp (file)

Generic Function: room-density OBJECT

Package

box.dgen

Methods

Method: room-density (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: room-size-max OBJECT

Package

box.dgen

Methods

Method: room-size-max (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: room-size-min OBJECT

Package

box.dgen

Methods

Method: room-size-min (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Generic Function: stage-rooms OBJECT

Generic Function: (setf stage-rooms) NEW-VALUE OBJECT

Package

box.dgen

Methods

Method: stage-rooms (STAGE stage)

automatically generated reader method

Source

stage.lisp (file)

Method: (setf stage-rooms) NEW-VALUE (STAGE stage)

automatically generated writer method

Source

stage.lisp (file)

Generic Function: x1 OBJECT

Package

box.dgen

Methods

Method: x1 (STAGE-ROOM stage-room)

automatically generated reader method

Source

room.lisp (file)

Generic Function: x2 OBJECT

Package

box.dgen

Methods

Method: x2 (STAGE-ROOM stage-room)

automatically generated reader method

Source

room.lisp (file)

Generic Function: y1 OBJECT

Package

box.dgen

Methods

Method: y1 (STAGE-ROOM stage-room)

automatically generated reader method

Source

room.lisp (file)

Generic Function: y2 OBJECT

Package

box.dgen

Methods

Method: y2 (STAGE-ROOM stage-room)

automatically generated reader method

Source

room.lisp (file)

5.2.5 Structures

Structure: extent ()

Package

box.dgen

Source

neighborhood.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: minimum

Initform

0

Readers

extent-minimum (function)

Writers

(setf extent-minimum) (function)

Slot: maximum

Initform

1

Readers

extent-maximum (function)

Writers

(setf extent-maximum) (function)

Structure: graphs ()

Package

box.dgen

Source

graph.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: connectable

Readers

connectable (function)

Writers

(setf connectable) (function)

Slot: mst

Readers

mst (function)

Writers

(setf mst) (function)

Slot: final

Readers

final (function)

Writers

(setf final) (function)

Structure: nh ()

Package

box.dgen

Source

neighborhood.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: stage

Readers

nh-stage (function)

Writers

(setf nh-stage) (function)

Slot: x

Readers

nh-x (function)

Writers

(setf nh-x) (function)

Slot: y

Readers

nh-y (function)

Writers

(setf nh-y) (function)

Slot: extent

Initform

(box.dgen::make-extent)

Readers

nh-extent (function)

Writers

(setf nh-extent) (function)

Slot: set-fn

Initform

(function box.dgen::nset-default)

Readers

nh-set-fn (function)

Writers

(setf nh-set-fn) (function)

Slot: map-fn

Initform

(function box.dgen::nmap-default)

Readers

nh-map-fn (function)

Writers

(setf nh-map-fn) (function)

Structure: region ()

Package

box.dgen

Source

region.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: id

Readers

id (function)

Writers

(setf id) (function)

Slot: cells

Readers

cells (function)

Writers

(setf cells) (function)

5.2.6 Classes

Class: stage-room ()

Package

box.dgen

Source

room.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• intersectsp (method)
• intersectsp (method)
• initialize-instance (method)
• height (method)
• width (method)
• y2 (method)
• y1 (method)
• x2 (method)
• x1 (method)

Direct slots

Slot: %x1

Initargs

:x1

Readers

x1 (generic function)

Slot: %x2

Initargs

:x2

Readers

x2 (generic function)

Slot: %y1

Initargs

:y1

Readers

y1 (generic function)

Slot: %y2

Initargs

:y2

Readers

y2 (generic function)

Slot: %width

Initargs

:w

Readers

width (generic function)

Slot: %height

Initargs

:h

Readers

height (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions