[VirtualInput] Clean up camera changes

- Adjusted documentation
- Move VirtualInput#clear from onDoneLoadingPlayer to onPlayerJoinedClientSide
- Renamed VirtualInput#clear to VirtualInput#clearKeys for clarity
- Added clearNext methods to Keyboard and Mouse to be able to clear individual input methods. Also to be consistent with the camera angle

Author: ScribbleTAS

src/main/java/com/minecrafttas/mctcommon/events/EventClient.java

@@ -62,15 +62,19 @@ public static interface EventDoneLoadingWorld extends EventBase {
 	}
 
 	/**
-	 * Fired when the player is done loading, after the position has been loaded from the server side
+	 * Fired when the player is done loading, after the position has been loaded from the server side.<br>
+	 * This also fires every time the player switches dimensions.
+	 * 
 	 * @author Scribble
 	 * @see NetHandlerPlayClient#handlePlayerPosLook(net.minecraft.network.play.server.SPacketPlayerPosLook)
 	 */
 	@FunctionalInterface
 	public static interface EventDoneLoadingPlayer extends EventBase {
 
 		/**
-		 * Fired when the player is done loading, after the position has been loaded from the server side
+		 * Fired when the player is done loading, after the position has been loaded from the server side.<br>
+		 * This also fires every time the player switches dimensions.
+		 * 
 		 * @see NetHandlerPlayClient#handlePlayerPosLook(net.minecraft.network.play.server.SPacketPlayerPosLook)
 		 */
 		public void onDoneLoadingPlayer();

src/main/java/com/minecrafttas/tasmod/handlers/LoadingScreenHandler.java

@@ -6,13 +6,12 @@
 import com.minecrafttas.mctcommon.events.EventClient.EventDoneLoadingPlayer;
 import com.minecrafttas.mctcommon.events.EventClient.EventDoneLoadingWorld;
 import com.minecrafttas.mctcommon.events.EventClient.EventLaunchIntegratedServer;
+import com.minecrafttas.mctcommon.events.EventClient.EventPlayerJoinedClientSide;
 import com.minecrafttas.mctcommon.events.EventClient.EventPlayerLeaveClientSide;
 import com.minecrafttas.tasmod.TASmod;
 import com.minecrafttas.tasmod.TASmodClient;
-import com.minecrafttas.tasmod.mixin.playbackhooks.MixinEntityRenderer;
 import com.minecrafttas.tasmod.playback.PlaybackControllerClient;
 import com.minecrafttas.tasmod.util.LoggerMarkers;
-import com.minecrafttas.tasmod.virtual.VirtualInput;
 import com.minecrafttas.tasmod.virtual.VirtualInput.VirtualCameraAngleInput;
 
 import net.minecraft.client.Minecraft;
@@ -23,7 +22,7 @@
  * 
  * @author Scribble
  */
-public class LoadingScreenHandler implements EventLaunchIntegratedServer, EventClientGameLoop, EventDoneLoadingWorld, EventDoneLoadingPlayer, EventPlayerLeaveClientSide {
+public class LoadingScreenHandler implements EventLaunchIntegratedServer, EventClientGameLoop, EventDoneLoadingWorld, EventDoneLoadingPlayer, EventPlayerJoinedClientSide, EventPlayerLeaveClientSide {
 
 	private boolean waszero;
 	private boolean isLoading;
@@ -78,17 +77,7 @@ public boolean isLoading() {
 	/**
 	 * {@inheritDoc}
 	 * 
-	 * <p>Fixes an issue, where the look position of the player is reset to 0 -180,<br>
-	 * As well as removing any keyboard inputs present in the main menu
-	 * 
-	 * <p>{@link MixinEntityRenderer#runUpdate(float)} rewrites the camera input,<br>
-	 * So that it can be used with interpolation. <br>
-	 * However, when you start the game, this camera input needs to be initialised with the current look position from the server.<br>
-	 * So a special condition is set, that if the {@link VirtualInput#CAMERA_ANGLE} is null,<br>
-	 * it intialises the {@link VirtualInput#CAMERA_ANGLE CAMERA_ANGLE} with the current player camera angle.
-	 * 
-	 * <p>So {@link VirtualInput#clear()} has to be called at the right moment in the player initialisation<br>
-	 * to set the correct values. Before that, the playerRotation defaults to 0 -180
+	 * <p>Initializes the virtual camera to be in line with the vanilla camera.
 	 */
 	@Override
 	public void onDoneLoadingPlayer() {
@@ -99,15 +88,29 @@ public void onDoneLoadingPlayer() {
 			Minecraft mc = Minecraft.getMinecraft();
 			EntityPlayerSP player = mc.player;
 			cameraAngle.setCamera(player.rotationPitch, player.rotationYaw);
-			TASmodClient.virtual.clear();
 		}
 	}
 
+	/**
+	 * {@inheritDoc}
+	 * 
+	 * <p>Fixes stuck keys when loading the world  
+	 */
+	@Override
+	public void onPlayerJoinedClientSide(EntityPlayerSP player) {
+		TASmodClient.virtual.clearKeys();
+	}
+
+	/**
+	 * {@inheritDoc}
+	 * 
+	 * <p>Resets the camera angle when leaving the world.
+	 * <p>If you later rejoin the world {@link #onDoneLoadingPlayer()} will re-initialise the camera angle
+	 */
 	@Override
 	public void onPlayerLeaveClientSide(EntityPlayerSP player) {
 		LOGGER.debug(LoggerMarkers.Event, "Finished leaving on the on the client side");
-		LOGGER.debug("Resetting pitch and yaw");
-		TASmodClient.virtual.CAMERA_ANGLE.clear();
+		LOGGER.debug("Resetting the camera angle on leaving the world");
+		TASmodClient.virtual.CAMERA_ANGLE.clearNext();
 	}
-
 }

src/main/java/com/minecrafttas/tasmod/playback/PlaybackControllerClient.java

@@ -245,7 +245,7 @@ public String setTASStateClient(TASstate stateIn, boolean verbose) {
 					LOGGER.debug(LoggerMarkers.Playback, "Pausing a playback");
 					state = TASstate.PAUSED;
 					stateAfterPause = TASstate.PLAYBACK;
-					TASmodClient.virtual.clear();
+					TASmodClient.virtual.clearKeys();
 					return verbose ? TextFormatting.GREEN + "Pausing a playback" : "";
 				case NONE:
 					stopPlayback(true);
@@ -291,7 +291,7 @@ private void startRecording() {
 
 	private void stopRecording() {
 		LOGGER.debug(LoggerMarkers.Playback, "Stopping a recording");
-		TASmodClient.virtual.clear();
+		TASmodClient.virtual.clearKeys();
 	}
 
 	private void startPlayback() {
@@ -305,7 +305,7 @@ private void stopPlayback(boolean clearInputs) {
 		LOGGER.debug(LoggerMarkers.Playback, "Stopping a playback");
 		Minecraft.getMinecraft().gameSettings.chatLinks = true;
 		if (clearInputs) {
-			TASmodClient.virtual.clear();
+			TASmodClient.virtual.clearKeys();
 		}
 	}
 

src/main/java/com/minecrafttas/tasmod/savestates/SavestateHandlerClient.java

@@ -203,7 +203,7 @@ public static void loadstate(String nameOfSavestate) throws Exception {
 
 			preload(savestateContainerList, index);
 			controller.setInputs(savestateContainerList, index);
-			TASmodClient.virtual.clear();
+			TASmodClient.virtual.clearKeys();
 		}
 		/*
 		 * When loading a savestate during a playback 2 different scenarios can happen.
@@ -237,7 +237,7 @@ else if (state == TASstate.PLAYBACK) {
 
 				preload(controller.getInputs(), index);
 				controller.setIndex(index);
-				TASmodClient.virtual.clear();
+				TASmodClient.virtual.clearKeys();
 			}
 			/*
 			 * Scenario 2:

src/main/java/com/minecrafttas/tasmod/virtual/VirtualInput.java

@@ -134,9 +134,9 @@ public boolean willKeyBeDown(int keycode) {
 	/**
 	 * Unpresses all keys in {@link VirtualKeyboardInput#nextKeyboard} and {@link VirtualMouseInput#nextMouse}
 	 */
-	public void clear() {
-		KEYBOARD.nextKeyboard.clear();
-		MOUSE.nextMouse.clear();
+	public void clearKeys() {
+		KEYBOARD.clearNext();
+		MOUSE.clearNext();
 	}
 
 	public void preloadInput(VirtualKeyboard keyboardToPreload, VirtualMouse mouseToPreload, VirtualCameraAngle angleToPreload) {
@@ -339,6 +339,13 @@ public boolean isKeyDown(int keycode) {
 		public boolean willKeyBeDown(int keycode) {
 			return nextKeyboard.isKeyDown(keycode);
 		}
+
+		/**
+		 * Clears the {@link #nextKeyboard}
+		 */
+		public void clearNext() {
+			nextKeyboard.clear();
+		}
 	}
 
 	/**
@@ -530,6 +537,12 @@ public boolean willKeyBeDown(int keycode) {
 			return nextMouse.isKeyDown(keycode);
 		}
 
+		/**
+		 * Clears the {@link #nextMouse}
+		 */
+		public void clearNext() {
+			nextMouse.clear();
+		}
 	}
 
 	/**
@@ -710,7 +723,10 @@ public Triple<Float, Float, Float> getInterpolatedState(float partialTick, float
 			return Triple.of(interpolatedPitch, interpolatedYaw, 0f);
 		}
 
-		public void clear() {
+		/**
+		 * Clears the {@link #nextCameraAngle}
+		 */
+		public void clearNext() {
 			nextCameraAngle.clear();
 		}
 	}