TerrainGenerator.java
| Index Score | ||
|---|---|---|
 |
 |
net.sf.freecol.server.generator |
 |
 |
FreeCol |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| LOOPS | Number of loops |  |
| COMPARISONS | Number of comparison operators | |
| EXEC_COMMENTS | Comments in executable code | |
| CYCLOMATIC | Cyclomatic complexity | |
| SIZE | Size of the file in bytes | |
| BLOCKS | Number of blocks | |
| LINE_COMMENT | Number of line comments | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| OPERANDS | Number of operands | |
| EXITS | Procedure exits | |
| LOGICAL_LINES | Number of statements | |
| ELOC | Effective lines of code | |
| JAVA0125 | JAVA0125 Continue statement with label | |
| LOC | Lines of code | |
| JAVA0076 | JAVA0076 Use of magic number | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LINES | Number of lines in the source file | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| COMMENTS | Comment lines | |
| DOC_COMMENT | Number of javadoc comment lines | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0287 | JAVA0287 Unnecessary null check | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/**
* Copyright (C) 2002-2007 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* FreeCol is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.server.generator;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Queue;
import java.util.Random;
import java.util.logging.Logger;
import net.sf.freecol.FreeCol;
import net.sf.freecol.common.model.Game;
import net.sf.freecol.common.model.Map;
import net.sf.freecol.common.model.Map.Direction;
import net.sf.freecol.common.model.Map.Position;
import net.sf.freecol.common.model.Region;
import net.sf.freecol.common.model.Region.RegionType;
import net.sf.freecol.common.model.Tile;
import net.sf.freecol.common.model.TileItemContainer;
import net.sf.freecol.common.model.TileType;
import net.sf.freecol.server.model.ServerRegion;
import net.sf.freecol.common.util.RandomChoice;
/**
* Class for making a <code>Map</code> based upon a land map.
*/
public class TerrainGenerator {
private static final Logger logger = Logger.getLogger(TerrainGenerator.class.getName());
public static final int REGION_SCORE_VALUE = 10;
public static final int PACIFIC_SCORE_VALUE = 100;
private final MapGeneratorOptions mapGeneratorOptions;
private final Random random = new Random();
private TileType ocean = FreeCol.getSpecification().getTileType("model.tile.ocean");
private TileType lake = FreeCol.getSpecification().getTileType("model.tile.lake");
private ArrayList<TileType> terrainTileTypes = null;
/**
* Creates a new <code>TerrainGenerator</code>.
*
* @see #createMap
*/
public TerrainGenerator(MapGeneratorOptions mapGeneratorOptions) {
this.mapGeneratorOptions = mapGeneratorOptions;
}
/**
* Creates a <code>Map</code> for the given <code>Game</code>.
*
* The <code>Map</code> is added to the <code>Game</code> after
* it is created.
*
* @param game The game.
* @param landMap Determines whether there should be land
* or ocean on a given tile. This array also
* specifies the size of the map that is going
* to be created.
* @see Map
*/
public void createMap(Game game, boolean[][] landMap) {
createMap(game, null, landMap);
}
/**
* Creates a <code>Map</code> for the given <code>Game</code>.
*
* The <code>Map</code> is added to the <code>Game</code> after
* it is created.
*
* @param game The game.
* @param importGame The game to import information form.
* @param landMap Determines whether there should be land
* or ocean on a given tile. This array also
* specifies the size of the map that is going
* to be created.
* @see Map
*/
public void createMap(Game game, Game importGame, boolean[][] landMap) {
final int width = landMap.length;
final int height = landMap[0].length;
final boolean importTerrain = (importGame != null) && getMapGeneratorOptions().getBoolean(MapGeneratorOptions.IMPORT_TERRAIN);
final boolean importBonuses = (importGame != null) && getMapGeneratorOptions().getBoolean(MapGeneratorOptions.IMPORT_BONUSES);
boolean mapHasLand = false;
Tile[][] tiles = new Tile[width][height];
for (int y = 0; y < height; y++) {
int latitude = (Math.min(y, (height-1) - y) * 200) / height; // lat=0 for poles; lat=100 for equator
for (int x = 0; x < width; x++) {
if (landMap[x][y]) {
mapHasLand = true;
}
Tile t;
if (importTerrain && importGame.getMap().isValid(x, y)) {
Tile importTile = importGame.getMap().getTile(x, y);
if (importTile.isLand() == landMap[x][y]) {
t = new Tile(game, importTile.getType(), x, y);
// TileItemContainer copies everything including Resource unless importBonuses == false
if (importTile.getTileItemContainer() != null) {
TileItemContainer container = new TileItemContainer(game, t);
container.copyFrom(importTile.getTileItemContainer(), importBonuses);
t.setTileItemContainer(container);
}
} else {
t = createTile(game, x, y, landMap, latitude);
}
} else {
t = createTile(game, x, y, landMap, latitude);
}
tiles[x][y] = t;
}
}
Map map = new Map(game, tiles);
game.setMap(map);
if (!importTerrain) {
createRegions(map);
createHighSeas(map);
if (mapHasLand) {
createMountains(map);
findLakes(map);
createRivers(map);
}
}
// Add the bonuses only after the map is completed.
// Otherwise we risk creating resources on fields where they
// don't belong (like sugar in large rivers or tobaco on hills).
if (!importBonuses) {
for (int y = 0; y < height; y++) {
for (int x = 0; x < width; x++) {
perhapsAddBonus(tiles[x][y], landMap);
}
}
}
}
private Tile createTile(Game game, int x, int y, boolean[][] landMap, int latitude) {
Tile t;
if (landMap[x][y]) {
t = new Tile(game, getRandomLandTileType(latitude), x, y);
} else {
t = new Tile(game, ocean, x, y);
}
perhapsAddBonus(t, landMap);
return t;
}
/**
* Adds a terrain bonus with a probability determined by the
* <code>MapGeneratorOptions</code>.
*
* @param t The Tile.
* @param landMap The landMap.
*/
private void perhapsAddBonus(Tile t, boolean[][] landMap) {
if (t.isLand()) {
if (random.nextInt(100) < getMapGeneratorOptions().getPercentageOfBonusTiles()) {
// Create random Bonus Resource
t.setResource(RandomChoice.getWeightedRandom(random, t.getType().getWeightedResources()));
}
} else {
int adjacentLand = 0;
for (Direction direction : Direction.values()) {
Position mp = Map.getAdjacent(t.getPosition(), direction);
final boolean valid = Map.isValid(mp, landMap.length, landMap[0].length);
if (valid && landMap[mp.getX()][mp.getY()]) {
adjacentLand++;
}
}
if (adjacentLand > 1 && random.nextInt(10 - adjacentLand) == 0) {
if (t.getTileItemContainer() == null) {
t.setTileItemContainer(new TileItemContainer(t.getGame(), t));
}
t.setResource(RandomChoice.getWeightedRandom(random, t.getType().getWeightedResources()));
}
}
}
/**
* Gets the <code>MapGeneratorOptions</code>.
* @return The <code>MapGeneratorOptions</code> being used
* when creating terrain.
*/
private MapGeneratorOptions getMapGeneratorOptions() {
return mapGeneratorOptions;
}
/**
* Gets a random land tile type based on the given percentage.
*
* @param latitudePercent The location of the tile relative to the north/south poles and equator,
* 100% is the mid-section of the map (equator)
* 0% is on the top/bottom of the map (poles).
*/
private TileType getRandomLandTileType(int latitudePercent) {
// decode options
final int forestChance = getMapGeneratorOptions().getPercentageOfForests();
final int humidityPreference = getMapGeneratorOptions().getHumidity();
final int temperaturePreference = getMapGeneratorOptions().getTemperature();
// create the main list of TileTypes the first time, and reuse it afterwards
if (terrainTileTypes==null) {
terrainTileTypes = new ArrayList<TileType>();
for (TileType tileType : FreeCol.getSpecification().getTileTypeList()) {
if (tileType.getId().equals("model.tile.hills") ||
tileType.getId().equals("model.tile.mountains") ||
tileType.isWater()) {
// do not generate hills or mountains at this time
// they are created separately
continue;
}
terrainTileTypes.add(tileType);
}
}
// temperature calculation
int poleTemperature = -20;
int equatorTemperature= 40;
if (temperaturePreference==MapGeneratorOptions.TEMPERATURE_COLD) {
poleTemperature = -20;
equatorTemperature = 25;
} else if (temperaturePreference==MapGeneratorOptions.TEMPERATURE_CHILLY) {
poleTemperature = -20;
equatorTemperature = 30;
} else if (temperaturePreference==MapGeneratorOptions.TEMPERATURE_TEMPERATE) {
poleTemperature = -10;
equatorTemperature = 35;
} else if (temperaturePreference==MapGeneratorOptions.TEMPERATURE_WARM) {
poleTemperature = -5;
equatorTemperature = 40;
} else if (temperaturePreference==MapGeneratorOptions.TEMPERATURE_HOT) {
poleTemperature = 0;
equatorTemperature = 40;
}
int temperatureRange = equatorTemperature-poleTemperature;
int localeTemperature = poleTemperature + latitudePercent*temperatureRange/100;
int temperatureDeviation = 7; // +/- 7 degrees randomization
localeTemperature += random.nextInt(temperatureDeviation*2)-temperatureDeviation;
if (localeTemperature>40)
localeTemperature = 40;
if (localeTemperature<-20)
localeTemperature = -20;
// humidity calculation
int averageHumidity = 50;
if (humidityPreference==MapGeneratorOptions.HUMIDITY_VERY_DRY) {
averageHumidity = 25;
} else if (humidityPreference==MapGeneratorOptions.HUMIDITY_DRY) {
averageHumidity = 35;
} else if (humidityPreference==MapGeneratorOptions.HUMIDITY_NORMAL) {
averageHumidity = 40;
} else if (humidityPreference==MapGeneratorOptions.HUMIDITY_WET) {
averageHumidity = 55;
} else if (humidityPreference==MapGeneratorOptions.HUMIDITY_VERY_WET) {
averageHumidity = 60;
}
int localeHumidity = averageHumidity;
int humidityDeviation = 20; // +/- 20% randomization
localeHumidity += random.nextInt(humidityDeviation*2) - humidityDeviation;
if (localeHumidity<0)
localeHumidity = 0;
if (localeHumidity>100)
localeHumidity = 100;
// initialize list of candidates with all terrain TileTypes
ArrayList<TileType> candidateTileTypes = new ArrayList<TileType>();
candidateTileTypes.addAll(terrainTileTypes);
// remove those that do not match the current temperature
Iterator<TileType> it = candidateTileTypes.iterator();
while (it.hasNext()) {
TileType t = it.next();
if (!t.withinRange(TileType.RangeType.TEMPERATURE, localeTemperature)) {
it.remove();
}
}
if (candidateTileTypes.size() == 1) {
return candidateTileTypes.get(0);
} else if (candidateTileTypes.size()==0) {
throw new RuntimeException("No TileType for temperature==" + localeTemperature );
}
// remove those that do not match the current humidity
it = candidateTileTypes.iterator();
while (it.hasNext()) {
TileType t = it.next();
if (!t.withinRange(TileType.RangeType.HUMIDITY, localeHumidity)) {
it.remove();
}
}
if (candidateTileTypes.size() == 1) {
return candidateTileTypes.get(0);
} else if (candidateTileTypes.size()==0) {
throw new RuntimeException("No TileType for temperature==" + localeTemperature
+" and humidity==" + localeHumidity);
}
// Choose based on forested/unforested
boolean forested = random.nextInt(100) < forestChance;
it = candidateTileTypes.iterator();
while (it.hasNext()) {
TileType t = it.next();
if (t.isForested() != forested) {
it.remove();
}
}
if (candidateTileTypes.size() == 1) {
return candidateTileTypes.get(0);
} else if (candidateTileTypes.size()==0) {
throw new RuntimeException("No TileType for temperature==" + localeTemperature
+" and humidity==" + localeHumidity + " and forested=="+forested);
}
// All scoped, if none have been selected by elimination, randomly choose one
TileType chosen = null;
if (chosen == null) {
chosen = candidateTileTypes.get(random.nextInt(candidateTileTypes.size()));
}
return chosen;
}
/**
* Creates map regions in the given Map. At the moment, the land
* is divided into three by three regions, and the ocean into two
* by two regions.
*
* @param map a <code>Map</code> value
*/
private void createRegions(Map map) {
Game game = map.getGame();
ServerRegion pacific =
new ServerRegion(game, "model.region.pacific", RegionType.OCEAN);
ServerRegion northPacific =
new ServerRegion(game, "model.region.northPacific", RegionType.OCEAN, pacific);
ServerRegion southPacific =
new ServerRegion(game, "model.region.southPacific", RegionType.OCEAN, pacific);
ServerRegion atlantic =
new ServerRegion(game, "model.region.atlantic", RegionType.OCEAN);
ServerRegion northAtlantic =
new ServerRegion(game, "model.region.northAtlantic", RegionType.OCEAN, atlantic);
ServerRegion southAtlantic =
new ServerRegion(game, "model.region.southAtlantic", RegionType.OCEAN, atlantic);
ServerRegion center =
new ServerRegion(game, "model.region.center", RegionType.LAND);
ServerRegion north =
new ServerRegion(game, "model.region.north", RegionType.LAND);
ServerRegion south =
new ServerRegion(game, "model.region.south", RegionType.LAND);
ServerRegion east =
new ServerRegion(game, "model.region.east", RegionType.LAND);
ServerRegion west =
new ServerRegion(game, "model.region.west", RegionType.LAND);
ServerRegion northEast =
new ServerRegion(game, "model.region.northEast", RegionType.LAND);
ServerRegion northWest =
new ServerRegion(game, "model.region.northWest", RegionType.LAND);
ServerRegion southEast =
new ServerRegion(game, "model.region.southEast", RegionType.LAND);
ServerRegion southWest =
new ServerRegion(game, "model.region.southWest", RegionType.LAND);
ServerRegion arctic =
new ServerRegion(game, "model.region.arctic", RegionType.LAND);
ServerRegion antarctic =
new ServerRegion(game, "model.region.antarctic", RegionType.LAND);
for (ServerRegion region : new ServerRegion[] { northPacific, southPacific,
atlantic, northAtlantic, southAtlantic,
northWest, north, northEast,
west, center, east,
southWest, south, southEast } ) {
if (region.getType() == RegionType.OCEAN) {
region.setPrediscovered(true);
} else {
region.setDiscoverable(true);
region.setScoreValue(REGION_SCORE_VALUE);
}
map.setRegion(region);
}
map.setRegion(pacific);
pacific.setDiscoverable(true);
pacific.setScoreValue(PACIFIC_SCORE_VALUE);
map.setRegion(arctic);
arctic.setPrediscovered(true);
map.setRegion(antarctic);
antarctic.setPrediscovered(true);
int halfHeight = map.getHeight()/2;
int halfWidth = map.getWidth()/2;
int thirdHeight = map.getHeight()/3;
int twoThirdHeight = 2 * thirdHeight;
int thirdWidth = map.getWidth()/3;
int twoThirdWidth = 2 * thirdWidth;
int arcticHeight = LandGenerator.POLAR_HEIGHT;
int antarcticHeight = map.getHeight() - LandGenerator.POLAR_HEIGHT - 1;
for (int y = 0; y < map.getHeight(); y++) {
for (int x = 0; x < map.getWidth(); x++) {
if (map.isValid(x, y)) {
Tile tile = map.getTile(x, y);
if (tile.isLand()) {
if (y < arcticHeight) {
arctic.addTile(tile);
} else if (y < thirdHeight) {
if (x < thirdWidth) {
northWest.addTile(tile);
} else if (x < twoThirdWidth) {
north.addTile(tile);
} else {
northEast.addTile(tile);
}
} else if (y < twoThirdHeight) {
if (x < thirdWidth) {
west.addTile(tile);
} else if (x < twoThirdWidth) {
center.addTile(tile);
} else {
east.addTile(tile);
}
} else if (y < antarcticHeight) {
if (x < thirdWidth) {
southWest.addTile(tile);
} else if (x < twoThirdWidth) {
south.addTile(tile);
} else {
southEast.addTile(tile);
}
} else {
antarctic.addTile(tile);
}
} else {
if (y < halfHeight) {
if (x < halfWidth) {
northPacific.addTile(tile);
} else {
northAtlantic.addTile(tile);
}
} else {
if (x < halfWidth) {
southPacific.addTile(tile);
} else {
southAtlantic.addTile(tile);
}
}
}
}
}
}
}
/**
* Places "high seas"-tiles on the border of the given map.
* @param map The <code>Map</code> to create high seas on.
*/
private void createHighSeas(Map map) {
createHighSeas(map,
getMapGeneratorOptions().getDistLandHighSea(),
getMapGeneratorOptions().getMaxDistToEdge()
);
}
/**
* Places "high seas"-tiles on the border of the given map.
*
* All other tiles previously of type {@link Tile#HIGH_SEAS}
* will be set to {@link Tile#OCEAN}.
*
* @param map The <code>Map</code> to create high seas on.
* @param distToLandFromHighSeas The distance between the land
* and the high seas (given in tiles).
* @param maxDistanceToEdge The maximum distance a high sea tile
* can have from the edge of the map.
*/
public static void determineHighSeas(Map map,
int distToLandFromHighSeas,
int maxDistanceToEdge) {
// lookup ocean TileTypes from xml specification
TileType ocean = null, highSeas = null;
for (TileType t : FreeCol.getSpecification().getTileTypeList()) {
if (t.isWater()) {
if (t.canSailToEurope()) {
if (highSeas == null) {
highSeas = t;
if (ocean != null) {
break;
}
}
} else {
if (ocean == null) {
ocean = t;
if (highSeas != null) {
break;
}
}
}
}
}
if (highSeas == null || ocean == null) {
throw new RuntimeException("Both Ocean and HighSeas TileTypes must be defined");
}
// reset all water tiles to default ocean type, and remove regions
for (Tile t : map.getAllTiles()) {
t.setRegion(null);
if (t.getType() == highSeas) {
t.setType(ocean);
}
}
// recompute the new high seas layout
createHighSeas(map, distToLandFromHighSeas, maxDistanceToEdge);
}
/**
* Places "high seas"-tiles on the border of the given map.
*
* @param map The <code>Map</code> to create high seas on.
* @param distToLandFromHighSeas The distance between the land
* and the high seas (given in tiles).
* @param maxDistanceToEdge The maximum distance a high sea tile
* can have from the edge of the map.
*/
private static void createHighSeas(Map map,
int distToLandFromHighSeas,
int maxDistanceToEdge) {
if (distToLandFromHighSeas < 0
|| maxDistanceToEdge < 0) {
throw new IllegalArgumentException("The integer arguments cannot be negative.");
}
TileType highSeas = null;
for (TileType t : FreeCol.getSpecification().getTileTypeList()) {
if (t.isWater()) {
if (t.canSailToEurope()) {
highSeas = t;
break;
}
}
}
if (highSeas == null) {
throw new RuntimeException("HighSeas TileType is defined by the 'sail-to-europe' attribute");
}
for (int y = 0; y < map.getHeight(); y++) {
for (int x=0; x<maxDistanceToEdge &&
x<map.getWidth() &&
!map.isLandWithinDistance(x, y, distToLandFromHighSeas); x++) {
if (map.isValid(x, y)) {
map.getTile(x, y).setType(highSeas);
}
}
for (int x=1; x<=maxDistanceToEdge &&
x<=map.getWidth()-1 &&
!map.isLandWithinDistance(map.getWidth()-x, y, distToLandFromHighSeas); x++) {
if (map.isValid(map.getWidth()-x, y)) {
map.getTile(map.getWidth()-x, y).setType(highSeas);
}
}
}
}
/**
* Creates mountain ranges on the given map. The number and size
* of mountain ranges depends on the map size.
*
* @param map The map to use.
*/
private void createMountains(Map map) {
float randomHillsRatio = 0.5f;
// 50% of user settings will be allocated for random hills here and there
// the rest will be allocated for large mountain ranges
int maximumLength = Math.max(getMapGeneratorOptions().getWidth(), getMapGeneratorOptions().getHeight()) / 10;
int number = (int)(getMapGeneratorOptions().getNumberOfMountainTiles()*(1-randomHillsRatio));
logger.info("Number of land tiles is " + getMapGeneratorOptions().getLand() +
", number of mountain tiles is " + number);
logger.fine("Maximum length of mountain ranges is " + maximumLength);
// lookup the resources from specification
TileType hills = FreeCol.getSpecification().getTileType("model.tile.hills");
TileType mountains = FreeCol.getSpecification().getTileType("model.tile.mountains");
if (hills == null || mountains == null) {
throw new RuntimeException("Both Hills and Mountains TileTypes must be defined");
}
// generate the mountain ranges
int counter = 0;
nextTry: for (int tries = 0; tries < 100; tries++) {
if (counter < number) {
Position p = map.getRandomLandPosition();
if (p == null) {
// this can only happen if the map contains no land
return;
}
Tile startTile = map.getTile(p);
if (startTile.getType() == hills || startTile.getType() == mountains) {
// already a high ground
continue;
}
// do not start a mountain range too close to another
Iterator<Position> it = map.getCircleIterator(p, true, 3);
while (it.hasNext()) {
if (map.getTile(it.next()).getType() == mountains) {
continue nextTry;
}
}
// do not add a mountain range too close to the ocean/lake
// this helps with good locations for building colonies on shore
it = map.getCircleIterator(p, true, 2);
while (it.hasNext()) {
if (!map.getTile(it.next()).isLand()) {
continue nextTry;
}
}
ServerRegion mountainRegion = new ServerRegion(map.getGame(),
"model.region.mountain" + tries,
Region.RegionType.MOUNTAIN,
startTile.getRegion());
mountainRegion.setDiscoverable(true);
mountainRegion.setClaimable(true);
map.setRegion(mountainRegion);
Direction direction = map.getRandomDirection();
int length = maximumLength - random.nextInt(maximumLength/2);
for (int index = 0; index < length; index++) {
p = Map.getAdjacent(p, direction);
Tile nextTile = map.getTile(p);
if (nextTile == null || !nextTile.isLand())
continue;
nextTile.setType(mountains);
mountainRegion.addTile(nextTile);
counter++;
it = map.getCircleIterator(p, false, 1);
while (it.hasNext()) {
Tile neighborTile = map.getTile(it.next());
if (neighborTile==null || !neighborTile.isLand() || neighborTile.getType()==mountains)
continue;
int r = random.nextInt(8);
if (r == 0) {
neighborTile.setType(mountains);
mountainRegion.addTile(neighborTile);
counter++;
} else if (r > 2) {
neighborTile.setType(hills);
mountainRegion.addTile(neighborTile);
}
}
}
int scoreValue = 2 * mountainRegion.getSize();
mountainRegion.setScoreValue(scoreValue);
logger.info("Created mountain region (direction " + direction +
", length " + length + ", size " + mountainRegion.getSize() +
", score value " + scoreValue + ").");
}
}
logger.info("Added " + counter + " mountain range tiles.");
// and sprinkle a few random hills/mountains here and there
number = (int)(getMapGeneratorOptions().getNumberOfMountainTiles()*randomHillsRatio);
counter = 0;
nextTry: for (int tries = 0; tries < 1000; tries++) {
if (counter < number) {
Position p = map.getRandomLandPosition();
Tile t = map.getTile(p);
if (t.getType() == hills || t.getType() == mountains) {
// already a high ground
continue;
}
// do not add hills too close to a mountain range
// this would defeat the purpose of adding random hills
Iterator<Position> it = map.getCircleIterator(p, true, 3);
while (it.hasNext()) {
if (map.getTile(it.next()).getType() == mountains) {
continue nextTry;
}
}
// do not add hills too close to the ocean/lake
// this helps with good locations for building colonies on shore
it = map.getCircleIterator(p, true, 1);
while (it.hasNext()) {
if (!map.getTile(it.next()).isLand()) {
continue nextTry;
}
}
int k = random.nextInt(4);
if (k == 0) {
// 25% chance of mountain
t.setType(mountains);
} else {
// 75% chance of hill
t.setType(hills);
}
counter++;
}
}
logger.info("Added " + counter + " random hills tiles.");
}
/**
* Creates rivers on the given map. The number of rivers depends
* on the map size.
*
* @param map The map to create rivers on.
*/
private void createRivers(Map map) {
int number = getMapGeneratorOptions().getNumberOfRivers();
int counter = 0;
HashMap<Position, River> riverMap = new HashMap<Position, River>();
List<River> rivers = new ArrayList<River>();
for (int i = 0; i < number; i++) {
nextTry: for (int tries = 0; tries < 100; tries++) {
Position position = map.getRandomLandPosition();
if (!map.getTile(position).getType().canHaveRiver()) {
continue;
}
// check the river source/spring is not too close to the ocean
Iterator<Position> it = map.getCircleIterator(position, true, 2);
while (it.hasNext()) {
Tile neighborTile = map.getTile(it.next());
if (!neighborTile.isLand()) {
continue nextTry;
}
}
if (riverMap.get(position) == null) {
// no river here yet
ServerRegion riverRegion = new ServerRegion(map.getGame(),
"model.region.river" + i,
Region.RegionType.RIVER,
map.getTile(position).getRegion());
riverRegion.setDiscoverable(true);
riverRegion.setClaimable(true);
River river = new River(map, riverMap, riverRegion);
if (river.flowFromSource(position)) {
logger.fine("Created new river with length " + river.getLength());
map.setRegion(riverRegion);
rivers.add(river);
counter++;
break;
} else {
logger.fine("Failed to generate river.");
}
}
}
}
logger.info("Created " + counter + " rivers of maximum " + number + ".");
for (River river : rivers) {
ServerRegion region = river.getRegion();
int scoreValue = 0;
for (RiverSection section : river.getSections()) {
scoreValue += section.getSize();
}
scoreValue *= 2;
region.setScoreValue(scoreValue);
logger.info("Created river region (length " + river.getLength() +
", score value " + scoreValue + ").");
}
}
private void findLakes(Map map) {
Position p = null;
// Search for a reachable water tile on the vertical edge.
// No need to search on the horizental edges as they will
// be covered by the polar regions.
for (int x : new int[] {0, map.getWidth() - 1}) {
for (int y = 0; y < map.getHeight(); y++) {
Tile tile = map.getTile(x, y);
if (tile != null && tile.getType() != null && !tile.isLand()) {
p = new Position(x, y);
break;
}
}
}
if (p == null) {
// This should not happen!
logger.warning("Find lakes: unable to find entry point.");
return;
}
// Find all reachable water tiles using a floodfill algorithm and BFS.
Queue<Position>q = new LinkedList<Position>();
boolean[][] visited = new boolean[map.getWidth()][map.getHeight()];
visited[p.getX()][p.getY()] = true;
do {
for (Direction direction : Direction.values()) {
Position n = Map.getAdjacent(p, direction);
if (map.getTile(n) != null && !map.getTile(n).isLand() &&
!visited[n.getX()][n.getY()]) {
visited[n.getX()][n.getY()] = true;
q.add(n);
}
}
p = q.poll();
} while (p != null);
// Every water tile we did not reach is a lake.
for (int y=0; y < map.getHeight(); y++) {
for (int x=0; x < map.getWidth(); x++) {
if (!visited[x][y]) {
Tile tile = map.getTile(x, y);
if (tile != null && !tile.isLand()) {
tile.setType(lake);
}
}
}
}
}
}
The table below shows all metrics for TerrainGenerator.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 154.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 160.00 | Comment lines | |
| COMMENT_DENSITY | 0.32 | Comment density | |
| COMPARISONS | 159.00 | Number of comparison operators | |
| CYCLOMATIC | 156.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 14.00 | Comments in declarations | |
| DOC_COMMENT | 116.00 | Number of javadoc comment lines | |
| ELOC | 502.00 | Effective lines of code | |
| EXEC_COMMENTS | 35.00 | Comments in executable code | |
| EXITS | 102.00 | Procedure exits | |
| FUNCTIONS | 14.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 103.96 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 51.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 6.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 12.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 26.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 2.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 5.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 1.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 2.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 13.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 2.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 1.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 2.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 1.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 860.00 | Number of lines in the source file | |
| LINE_COMMENT | 44.00 | Number of line comments | |
| LOC | 622.00 | Lines of code | |
| LOGICAL_LINES | 327.00 | Number of statements | |
| LOOPS | 27.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 1647.00 | Number of operands | |
| OPERATORS | 3151.00 | Number of operators | |
| PARAMS | 25.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 4798.00 | Halstead program length | |
| PROGRAM_VOCAB | 455.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 26.00 | Number of return points from functions | |
| SIZE | 35470.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 404.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 51.00 | Number of unique operators | |
| WHITESPACE | 78.00 | Number of whitespace lines | |