Movable Refactoring

jsettlers.buildingcreator/src/main/java/jsettlers/buildingcreator/job/EBuildingJobType.java

@@ -0,0 +1,134 @@
+/*******************************************************************************
+ * Copyright (c) 2015
+ *
+ * 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.buildingcreator.job;
+
+public enum EBuildingJobType {
+	/**
+	 * Waits a given time.
+	 * <p>
+	 * SUCCESS: The time elapsed.
+	 * <p>
+	 * Fail: impossible.
+	 * 
+	 * @see BuildingJob#getTime();
+	 */
+	WAIT,
+	/**
+	 * Lets the settler walk in a given direction. The settler may wait.
+	 * <p>
+	 * Parameter: direction
+	 * <p>
+	 * SUCCESS: The settler is at the position
+	 * <p>
+	 * Fail: Should not happen normally.
+	 */
+	WALK,
+	/**
+	 * Shows the settler at a given position.
+	 * <p>
+	 * Parameter: dx, dy
+	 * <p>
+	 * SUCCESS: The settler appeared.
+	 * <p>
+	 * Fail: The settler could not appear at the given position.
+	 */
+	SHOW,
+	/**
+	 * Lets the settler disappear.
+	 * <p>
+	 * Parameter: none
+	 * <p>
+	 * SUCCESS: The settler disappeared instantly.
+	 * <p>
+	 * Fail: impossible
+	 */
+	HIDE,
+
+	/**
+	 * Sets the material property of the settler.
+	 * <p>
+	 * Parameter: material
+	 * <p>
+	 * SUCCESS: good
+	 * <p>
+	 * Fail: There was no given material at that position.
+	 */
+	SET_MATERIAL,
+
+	/**
+	 * Picks up the specified material. Does not change the material type assigned to the settler
+	 * <p>
+	 * Parameter: material
+	 * <p>
+	 * SUCCESS: There was a material at that position, one item was removed.
+	 * <p>
+	 * Fail: There was no given material at that position.
+	 */
+	TAKE,
+	/**
+	 * Lets the settler drop the given material to the stack at the positon.
+	 * <p>
+	 * Parameter: material
+	 * <p>
+	 * SUCCESS: When the settler dropped the material.
+	 * <p>
+	 * Fail: If the drop is impossible.
+	 */
+	DROP,
+	/**
+	 * Searches a given search type.
+	 * <p>
+	 * Uses the special {@link BuildingSearchJob} class.
+	 * <p>
+	 * SUCCESS: The settler found the thing he should search and went to it.
+	 * <p>
+	 * Fail: If the searched thing was not found. The settler does not need to go back.
+	 * 
+	 * @see BuildingSearchType
+	 */
+	SEARCH,
+	/**
+	 * Goes to the position relative to the building.
+	 * <p>
+	 * SUCCESS: The settler is at the position
+	 * <p>
+	 * Fail: The position is unreachable.
+	 */
+	GO_TO,
+
+	/**
+	 * Look at
+	 * <p>
+	 * SUCCESS: The settler looks at the given new direction.
+	 * <p>
+	 * Fail: impossible
+	 */
+	LOOK_AT,
+	/**
+	 * Plays an action animation.
+	 * <p>
+	 * Parameter: time - the time the action should take.
+	 * <p>
+	 * SUCCESS: The animation was played.
+	 * <p>
+	 * Fail: something was wrong...
+	 */
+	PLAY_ACTION1,
+	/**
+	 * @see EBuildingJobType#PLAY_ACTION1
+	 */
+	PLAY_ACTION2,
+	PLAY_ACTION3
+}

jsettlers.common/src/main/java/jsettlers/common/CommonConstants.java

@@ -14,8 +14,6 @@
  *******************************************************************************/
 package jsettlers.common;
 
-import jsettlers.common.ai.EPlayerType;
-
 public abstract class CommonConstants {
 	/**
 	 * A byte value indicating that the given position is visible.
@@ -69,8 +67,15 @@ public abstract class CommonConstants {
 	 * Option to disable the loading of original maps.
 	 */
 	public static boolean DISABLE_ORIGINAL_MAPS = false;
+
 	/**
 	 * Disables the checksum test for original maps.
 	 */
 	public static boolean DISABLE_ORIGINAL_MAPS_CHECKSUM = false;
+
+	/**
+	 * Enables debugging of behavior trees
+	 */
+	public static boolean DEBUG_BEHAVIOR_TREES = false;
+
 }

jsettlers.common/src/main/java/jsettlers/common/action/Action.java

@@ -17,7 +17,7 @@
 /**
  * This is a action the user has requested.
  * <p>
- * Each Action has an active status, that indicates that it is currently executed. When the execution of the action is begun, the flag should be set
+ * Each action has an active status, that indicates that it is currently executed. When the execution of the action is begun, the flag should be set
  * so that the user interface enters a blocking mode, and goes back to normal mode when the action is finished. It is not guaranteed that there is no
  * other action being sent during that time, e.g. an cancel-action.
  * <p>

jsettlers.common/src/main/java/jsettlers/common/buildings/jobs/EBuildingJobType.java

@@ -27,7 +27,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameter: time (in seconds)
 	 * <p>
-	 * Success: The time elapsed.
+	 * SUCCESS: The time elapsed.
 	 * <p>
 	 * Fail: impossible.
 	 * 
@@ -40,7 +40,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameter: direction
 	 * <p>
-	 * Success: The settler is at the position
+	 * SUCCESS: The settler is at the position
 	 * <p>
 	 * Fail: Should not happen normally.
 	 */
@@ -51,7 +51,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameter: dx, dy
 	 * <p>
-	 * Success: The settler appeared.
+	 * SUCCESS: The settler appeared.
 	 * <p>
 	 * Fail: The settler could not appear at the given position.
 	 */
@@ -62,7 +62,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameter: none
 	 * <p>
-	 * Success: The settler disappeared instantly.
+	 * SUCCESS: The settler disappeared instantly.
 	 * <p>
 	 * Fail: impossible
 	 */
@@ -73,7 +73,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameter: material
 	 * <p>
-	 * Success: always
+	 * SUCCESS: always
 	 * <p>
 	 * Fail: never
 	 */
@@ -84,7 +84,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameter: material
 	 * <p>
-	 * Success: There was a material at that position, one item was removed.
+	 * SUCCESS: There was a material at that position, one item was removed.
 	 * <p>
 	 * Fail: There was no given material at that position.
 	 */
@@ -97,7 +97,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameter: material
 	 * <p>
-	 * Success: When the settler dropped the material.
+	 * SUCCESS: When the settler dropped the material.
 	 * <p>
 	 * Fail: If the drop is impossible, e.g. because there is already material at that position.
 	 */
@@ -112,7 +112,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * This job always fails if the working radius is 0.
 	 * <p>
-	 * Success: A path to the searched thing has been found.
+	 * SUCCESS: A path to the searched thing has been found.
 	 * <p>
 	 * Fail: If the searched thing was not found.
 	 * <p>
@@ -132,7 +132,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * This job always fails if the working radius is 0.
 	 * <p>
-	 * Success: A path to the searched thing has been found.
+	 * SUCCESS: A path to the searched thing has been found.
 	 * <p>
 	 * Fail: If the searched thing was not found.
 	 * 
@@ -149,7 +149,7 @@ public enum EBuildingJobType {
 	/**
 	 * Goes to the position relative to the building.
 	 * <p>
-	 * Success: The settler is at the position
+	 * SUCCESS: The settler is at the position
 	 * <p>
 	 * Fail: The position is unreachable.
 	 */
@@ -178,7 +178,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameter: direction
 	 * <p>
-	 * Success: The settler looks at the given new direction.
+	 * SUCCESS: The settler looks at the given new direction.
 	 * <p>
 	 * Fail: impossible
 	 */
@@ -189,7 +189,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameter: time (the time the action should take)
 	 * <p>
-	 * Success: The animation was played.
+	 * SUCCESS: The animation was played.
 	 * <p>
 	 * Fail: should not happen.
 	 */
@@ -210,7 +210,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameters: type ({@link jsettlers.common.material.ESearchType})
 	 * <p>
-	 * Success: the given search type has been executed
+	 * SUCCESS: the given search type has been executed
 	 * <p>
 	 * Fail: the given search type couldn't be executed
 	 */
@@ -221,7 +221,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameters: dx, dy, material
 	 * <p>
-	 * Success: There is material at that position.
+	 * SUCCESS: There is material at that position.
 	 * <p>
 	 * Fail: There is no matching material at that position
 	 */
@@ -232,7 +232,7 @@ public enum EBuildingJobType {
 	 * <p>
 	 * Parameters: dx, dy, material
 	 * <p>
-	 * Success: The material may be placed at the given position
+	 * SUCCESS: The material may be placed at the given position
 	 * <p>
 	 * Fail: There is a full stack at that position, a wrong stack or it is blocked otherwise.
 	 */

jsettlers.graphics/src/main/java/jsettlers/graphics/image/reader/AdvancedDatFileReader.java

@@ -438,7 +438,7 @@ private void readSequencesAt(ByteReader reader, int sequenceIndexStart) throws I
 		int pointerCount = reader.read16();
 
 		if (byteCount != pointerCount * 4 + 8) {
-			throw new IOException("Sequence index block length (" + pointerCount + ") and " + "bytecount (" + byteCount + ") are not consistent.");
+			throw new IOException("sequence index block length (" + pointerCount + ") and " + "bytecount (" + byteCount + ") are not consistent.");
 		}
 
 		int[] sequenceIndexPointers = new int[pointerCount];

jsettlers.graphics/src/main/java/jsettlers/graphics/image/sequence/ArraySequence.java

@@ -45,7 +45,7 @@ public ArraySequence(T[] images) {
 	/*
 	 * (non-Javadoc)
 	 * 
-	 * @see Sequence#length()
+	 * @see sequence#length()
 	 */
 	@Override
 	public int length() {
@@ -55,7 +55,7 @@ public int length() {
 	/*
 	 * (non-Javadoc)
 	 * 
-	 * @see Sequence#getImageLink(int)
+	 * @see sequence#getImageLink(int)
 	 */
 	@Override
 	public T getImage(int index) {
@@ -66,7 +66,7 @@ public T getImage(int index) {
 	/*
 	 * (non-Javadoc)
 	 * 
-	 * @see Sequence#getImageSafe(int)
+	 * @see sequence#getImageSafe(int)
 	 */
 	@Override
 	public Image getImageSafe(int index) {

jsettlers.logic/build.gradle

@@ -21,6 +21,7 @@ task unitTest(type: Test) {
 dependencies {
     implementation project(':jsettlers.common')
     implementation project(':jsettlers.network')
+    implementation 'org.apache.commons:commons-text:1.3'
 
     testImplementation project(':jsettlers.testutils')
     testImplementation project(':jsettlers.main.swing')

jsettlers.logic/src/main/java/jsettlers/ai/highlevel/AiPositions.java

@@ -280,7 +280,7 @@ public String toString() {
 	}
 
 	public ShortPoint2D getBestRatedPoint(PositionRater rater) {
-		// TODO: Parallel ?
+		// TODO: parallel ?
 		int currentBestRating = PositionRater.RATE_INVALID;
 		ShortPoint2D currentBest = null;
 		for (int i = 0; i < size; i++) {

jsettlers.logic/src/main/java/jsettlers/ai/highlevel/pioneers/PioneerGroup.java

@@ -27,6 +27,7 @@
 import jsettlers.input.tasks.ConvertGuiTask;
 import jsettlers.logic.map.grid.movable.MovableGrid;
 import jsettlers.logic.movable.Movable;
+import jsettlers.logic.movable.MovableDataManager;
 import jsettlers.logic.movable.interfaces.ILogicMovable;
 import jsettlers.network.client.interfaces.ITaskScheduler;
 
@@ -60,7 +61,7 @@ public void clear() {
 	public void removeDeadPioneers() {
 		Collection<Integer> idsToRemove = new ArrayList<>(pioneerIds.size());
 		for (Integer pioneerId : pioneerIds) {
-			if (Movable.getMovableByID(pioneerId) == null) {
+			if (MovableDataManager.getMovableByID(pioneerId) == null) {
 				idsToRemove.add(pioneerId);
 			}
 		}
@@ -90,10 +91,11 @@ public void fill(ITaskScheduler taskScheduler, AiStatistics aiStatistics, byte p
 	}
 
 	public PioneerGroup getPioneersWithNoAction() {
-		List<Integer> pioneersWithNoAction = stream(pioneerIds).filter(pioneerId -> Movable.getMovableByID(pioneerId).getAction() == EMovableAction.NO_ACTION).collect(Collectors.toList());
+		List<Integer> pioneersWithNoAction = stream(pioneerIds).filter(pioneerId -> MovableDataManager.getMovableByID(pioneerId).getAction() == EMovableAction.NO_ACTION).collect(Collectors.toList());
 		return new PioneerGroup(pioneersWithNoAction);
 	}
 
+
 	public void addAll(List<Integer> pioneerIds) {
 		this.pioneerIds.addAll(pioneerIds);
 	}