Adventure at Umalu  22nd March, 2013
Rogue-like Dungeon Crawler, written in Java
 All Classes Functions Variables Pages
Public Member Functions | Protected Member Functions | List of all members
jade.gen.Generator Class Referenceabstract
Inheritance diagram for jade.gen.Generator:
jade.gen.feature.FeatureGenerator jade.gen.feature.Fence jade.gen.feature.Sprinkler

Public Member Functions

 Generator ()
 
 Generator (Generator chained)
 
final void generate (World world, Dice dice)
 
final void generate (World world)
 

Protected Member Functions

abstract void generateStep (World world, Dice dice)
 

Detailed Description

Represents a map generation algorithm. These generators can be chained together in decorator fashion to create a new composite

.

Constructor & Destructor Documentation

jade.gen.Generator.Generator ( )

Creates a new

with no previous chained

jade.gen.Generator.Generator ( Generator  chained)

Creates a new

with the given

as the previous chained

.

Parameters
chainedthe chained

Member Function Documentation

final void jade.gen.Generator.generate ( World  world,
Dice  dice 
)

Calls the generation step of the

, after the chained

has been called.

Parameters
worldthe
World
on which the generation algorithm is being performed on
dicethe
Dice
to be used for random number generation during map generation
final void jade.gen.Generator.generate ( World  world)

Calls the generation step of the

, after the chained

has been called. The global instance of

Dice

is used as the default random number generator.

Parameters
worldthe
World
on which the generation algorithm is being performed on
abstract void jade.gen.Generator.generateStep ( World  world,
Dice  dice 
)
protectedpure virtual

Performs the generation step of the

.

Parameters
worldthe
World
on which the generation algorithm is being performed on
dicethe
Dice
to be used for random number generation during map generation

Implemented in jade.gen.feature.Sprinkler, and jade.gen.feature.Fence.


The documentation for this class was generated from the following file: