ValidateSettler.java

/*******************************************************************************
 * Copyright (c) 2015 - 2016
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *******************************************************************************/
package jsettlers.mapcreator.mapvalidator.tasks.error;

import jsettlers.common.map.object.MapObject;
import jsettlers.common.map.object.MovableObject;
import jsettlers.common.movable.EMovableType;
import jsettlers.common.position.ShortPoint2D;
import jsettlers.graphics.localization.Labels;
import jsettlers.mapcreator.mapvalidator.result.fix.DeleteObjectFix;
import jsettlers.mapcreator.mapvalidator.tasks.AbstractValidationTask;

/**
 * Check that all "normal" settlers are within the land of the right player
 * 
 * @author Andreas Butti
 */
public class ValidateSettler extends AbstractValidationTask {

	/**
	 * Fix for wrong placed settlers
	 */
	private DeleteObjectFix fix = new DeleteObjectFix();

	/**
	 * Constructor
	 */
	public ValidateSettler() {
	}

	@Override
	public void doTest() {
		addHeader("settler.header", fix);

		for (int x = 0; x < data.getWidth(); x++) {
			for (int y = 0; y < data.getHeight(); y++) {
				MapObject mapObject = data.getMapObject(x, y);
				if (mapObject instanceof MovableObject) {
					testMoveableObject(x, y, (MovableObject) mapObject);
				}
			}
		}
	}

	/**
	 * Test if this movable object is valid at this position
	 * 
	 * @param x
	 *            X Pos
	 * @param y
	 *            Y Pos
	 * @param movableObject
	 *            MovableObject
	 */
	private void testMoveableObject(int x, int y, MovableObject movableObject) {
		EMovableType type = movableObject.getType();

		if (!type.needsPlayersGround()) {
			// don't need player ground, so don't check it here
			return;
		}

		if (players[x][y] != movableObject.getPlayerId()) {
			ShortPoint2D point = new ShortPoint2D(x, y);
			addErrorMessage("settler.wrong-land", point, Labels.getName(type), movableObject.getPlayerId(), players[x][y]);
			fix.addInvalidObject(point);
		}
	}

}