squidpony.squidgrid.mapping.IDungeonGenerator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of squidlib-util Show documentation

SquidLib platform-independent logic and utility code. Please refer to https://github.com/SquidPony/SquidLib .

There is a newer version: 3.0.6

package squidpony.squidgrid.mapping;

/**
 * Created by Tommy Ettinger on 6/1/2017.
 */
public interface IDungeonGenerator {
    /**
     * Generates a dungeon or other map as a 2D char array. Any implementation may allow its own configuration and
     * customization of how dungeons are generated, but each must provide this as a sane default. Most implementations
     * should use the convention of '#' representing a wall and '.' representing a bare floor, but beyond that, anything
     * could be present in the char array.
     * @return a 2D char array representing some kind of map, probably using standard conventions for walls/floors
     */
    char[][] generate();

    /**
     * Gets the most recently-produced dungeon as a 2D char array, usually produced by calling {@link #generate()} or
     * some similar method present in a specific implementation. This normally passes a direct reference and not a copy,
     * so you can normally modify the returned array to propagate changes back into this IDungeonGenerator.
     * @return the most recently-produced dungeon/map as a 2D char array
     */
    char[][] getDungeon();
}