Refactor PlaybackController (#200)

- Added new VirtualInput hooks to PlaybackController
- Added PlaybackMetdata for an easier way to add metadata to the TASFile
- Recreated existing metadata as PlaybackMetadataExtensions
- [VirtualInput] Fixed issues with Interpolation not working properly
- Fixed #185

Author: ScribbleTAS

.github/workflows/build.yml

@@ -19,7 +19,7 @@ jobs:
     - name: Setup Gradle
       uses: gradle/[email protected]
       with:
-        gradle-version: 8.4
+        gradle-version: 8.6
     - name: Build TASmod with Gradle
       run: gradle build
     - name: Upload Test Report

.github/workflows/buildandupload.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Setup Gradle
       uses: gradle/[email protected]
       with:
-        gradle-version: 8.4
+        gradle-version: 8.6
     - name: Build TASmod with Gradle
       run: gradle build
     - name: Upload artifact

gradle.properties

@@ -3,8 +3,8 @@ org.gradle.jvmargs=-Xmx3G
 
 # Fabric properties
 minecraft_version=1.12.2
-loader_version=0.15.6
-loom_version=1.5-SNAPSHOT
+loader_version=0.15.9
+loom_version=1.6-SNAPSHOT
 
 # Mod properties
 mod_name=Tool-Assisted Speedrun Mod

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

@@ -107,6 +107,18 @@ public static void register(EventBase eventListener) {
 		}
 	}
 
+	/**
+	 * Registers multiple objects to be an event listener. The objects must
+	 * implement an event extending {@link EventBase}
+	 * 
+	 * @param eventListeners The event listeners to register
+	 */
+	public static void register(EventBase... eventListeners) {
+		for (EventBase eventListener : eventListeners) {
+			register(eventListener);
+		}
+	}
+
 	/**
 	 * Unregisters an object from being an event listener.
 	 * 
@@ -130,6 +142,17 @@ public static void unregister(EventBase eventListener) {
 		}
 	}
 
+	/**
+	 * Unregisters multiple objects from being an event listener.
+	 * 
+	 * @param eventListener The event listeners to unregister
+	 */
+	public static void unregister(EventBase... eventListeners) {
+		for (EventBase eventListener : eventListeners) {
+			unregister(eventListener);
+		}
+	}
+
 	/**
 	 * Fires an event without parameters
 	 *
@@ -151,6 +174,7 @@ public static Object fireEvent(Class<? extends EventListenerRegistry.EventBase>
 	public static Object fireEvent(Class<? extends EventListenerRegistry.EventBase> eventClass, Object... eventParams) {
 		ArrayList<EventBase> listenerList = EVENTLISTENER_REGISTRY.get(eventClass);
 		if (listenerList == null) {
+//            throw new EventException("The event has not been registered yet", eventClass);
 			return null;
 		}
 
@@ -250,12 +274,7 @@ private static boolean checkTypes(Method method, Object... parameters) {
 		for (int i = 0; i < methodParameterTypes.length; i++) {
 			Class<?> paramName = methodParameterTypes[i];
 			Class<?> eventName = eventParameterTypes[i];
-
-			if (paramName == null || eventName == null) {
-				continue;
-			}
-
-			if (!paramName.equals(eventName) && !paramName.isAssignableFrom(eventName)) {
+			if (!paramName.equals(eventName) && (paramName != null && eventName != null && !paramName.isAssignableFrom(eventName))) {
 				return false;
 			}
 		}
@@ -265,7 +284,11 @@ private static boolean checkTypes(Method method, Object... parameters) {
 	private static Class<?>[] getParameterTypes(Object... parameters) {
 		Class<?>[] out = new Class[parameters.length];
 		for (int i = 0; i < parameters.length; i++) {
-			out[i] = parameters[i] == null ? null : parameters[i].getClass();
+			if (parameters[i] == null) {
+				out[i] = null;
+				continue;
+			}
+			out[i] = parameters[i].getClass();
 		}
 		return out;
 	}

src/main/java/com/minecrafttas/mctcommon/server/PacketHandlerRegistry.java

@@ -18,15 +18,15 @@ public class PacketHandlerRegistry {
 	private static final List<PacketHandlerBase> REGISTRY = new ArrayList<>();
 
 	public static void register(PacketHandlerBase handler) {
-		if(handler==null) {
+		if (handler == null) {
 			throw new NullPointerException("Tried to register a handler with value null");
 		}
-		
-		if(containsClass(handler)) {
+
+		if (containsClass(handler)) {
 			MCTCommon.LOGGER.warn("Trying to register packet handler {}, but another instance of this class is already registered!", handler.getClass().getName());
 			return;
 		}
-		
+
 		if (!REGISTRY.contains(handler)) {
 			REGISTRY.add(handler);
 		} else {
@@ -35,13 +35,13 @@ public static void register(PacketHandlerBase handler) {
 	}
 
 	public static void unregister(PacketHandlerBase handler) {
-		if(handler==null) {
+		if (handler == null) {
 			throw new NullPointerException("Tried to unregister a handler with value null");
 		}
 		if (REGISTRY.contains(handler)) {
 			REGISTRY.remove(handler);
 		} else {
-			MCTCommon.LOGGER.warn("Trying to unregister packet handler {}, but is was not registered!", handler.getClass().getName());
+			MCTCommon.LOGGER.warn("Trying to unregister packet handler {}, but it was not registered!", handler.getClass().getName());
 		}
 	}
 
@@ -65,14 +65,14 @@ public static void handle(Side side, PacketID packet, ByteBuffer buf, String use
 				}
 			}
 		}
-		if(!isImplemented) {
+		if (!isImplemented) {
 			throw new PacketNotImplementedException(packet, side);
 		}
 	}
-	
+
 	private static boolean containsClass(PacketHandlerBase handler) {
-		for(PacketHandlerBase packethandler : REGISTRY) {
-			if(packethandler.getClass().equals(handler.getClass())) {
+		for (PacketHandlerBase packethandler : REGISTRY) {
+			if (packethandler.getClass().equals(handler.getClass())) {
 				return true;
 			}
 		}

src/main/java/com/minecrafttas/tasmod/TASmod.java

@@ -27,6 +27,7 @@
 import com.minecrafttas.tasmod.ktrng.KillTheRNGHandler;
 import com.minecrafttas.tasmod.networking.TASmodPackets;
 import com.minecrafttas.tasmod.playback.PlaybackControllerServer;
+import com.minecrafttas.tasmod.playback.metadata.integrated.StartpositionMetadataExtension;
 import com.minecrafttas.tasmod.savestates.SavestateHandlerServer;
 import com.minecrafttas.tasmod.savestates.files.SavestateTrackerFile;
 import com.minecrafttas.tasmod.tickratechanger.TickrateChangerServer;
@@ -68,6 +69,8 @@ public class TASmod implements ModInitializer, EventServerInit, EventServerStop{
 
 	public static final boolean isDevEnvironment = FabricLoaderImpl.INSTANCE.isDevelopmentEnvironment();
 
+	public static final StartpositionMetadataExtension startPositionMetadataExtension = new StartpositionMetadataExtension();
+	
 	@Override
 	public void onInitialize() {
 
@@ -96,6 +99,7 @@ public void onInitialize() {
 		PacketHandlerRegistry.register(tickratechanger);
 		PacketHandlerRegistry.register(ktrngHandler);
 		PacketHandlerRegistry.register(playbackControllerServer);
+		PacketHandlerRegistry.register(startPositionMetadataExtension);
 	}
 
 	@Override

src/main/java/com/minecrafttas/tasmod/TASmodClient.java

@@ -28,7 +28,10 @@
 import com.minecrafttas.tasmod.networking.TASmodPackets;
 import com.minecrafttas.tasmod.playback.PlaybackControllerClient;
 import com.minecrafttas.tasmod.playback.PlaybackControllerClient.TASstate;
-import com.minecrafttas.tasmod.playback.PlaybackSerialiser;
+import com.minecrafttas.tasmod.playback.metadata.PlaybackMetadataRegistry;
+import com.minecrafttas.tasmod.playback.metadata.integrated.CreditsMetadataExtension;
+import com.minecrafttas.tasmod.playback.metadata.integrated.StartpositionMetadataExtension;
+import com.minecrafttas.tasmod.playback.tasfile.PlaybackSerialiser;
 import com.minecrafttas.tasmod.savestates.SavestateHandlerClient;
 import com.minecrafttas.tasmod.tickratechanger.TickrateChangerClient;
 import com.minecrafttas.tasmod.ticksync.TickSyncClient;
@@ -85,6 +88,10 @@ public class TASmodClient implements ClientModInitializer, EventClientInit, Even
 	public static SavestateHandlerClient savestateHandlerClient = new SavestateHandlerClient();
 
 	public static Client client;
+	
+	public static CreditsMetadataExtension creditsMetadataExtension = new CreditsMetadataExtension();
+	
+	public static StartpositionMetadataExtension startpositionMetadataExtension = new StartpositionMetadataExtension();
 	/**
 	 * The container where all inputs get stored during recording or stored and
 	 * ready to be played back
@@ -153,6 +160,12 @@ public void onInitializeClient() {
 			}
 			return gui;
 		}));
+		EventListenerRegistry.register(controller);
+		PlaybackMetadataRegistry.register(creditsMetadataExtension);
+		EventListenerRegistry.register(creditsMetadataExtension);
+		
+		PlaybackMetadataRegistry.register(startpositionMetadataExtension);
+		EventListenerRegistry.register(startpositionMetadataExtension);
 
 		// Register packet handlers
 		LOGGER.info(LoggerMarkers.Networking, "Registering network handlers on client");
@@ -195,14 +208,15 @@ public void onClientInit(Minecraft mc) {
 		})));
 		blockedKeybindings.add(keybindManager.registerKeybind(new Keybind("Open InfoGui Editor", "TASmod", Keyboard.KEY_F6, () -> Minecraft.getMinecraft().displayGuiScreen(TASmodClient.hud))));
 		blockedKeybindings.add(keybindManager.registerKeybind(new Keybind("Various Testing", "TASmod", Keyboard.KEY_F12, () -> {
-			TASmodClient.client.disconnect();
+			controller.setTASState(TASstate.RECORDING);
 		}, VirtualKeybindings::isKeyDown)));
 		blockedKeybindings.add(keybindManager.registerKeybind(new Keybind("Various Testing2", "TASmod", Keyboard.KEY_F7, () -> {
-			try {
-				TASmodClient.client = new Client("localhost", TASmod.networkingport-1, TASmodPackets.values(), mc.getSession().getProfile().getName(), true);
-			} catch (Exception e) {
-				e.printStackTrace();
-			}
+//			try {
+//				TASmodClient.client = new Client("localhost", TASmod.networkingport-1, TASmodPackets.values(), mc.getSession().getProfile().getName(), true);
+//			} catch (Exception e) {
+//				e.printStackTrace();
+//			}
+			controller.setTASState(TASstate.PLAYBACK);
 		}, VirtualKeybindings::isKeyDown)));
 		blockedKeybindings.forEach(VirtualKeybindings::registerBlockedKeyBinding);
 

src/main/java/com/minecrafttas/tasmod/commands/CommandLoadTAS.java

@@ -33,6 +33,7 @@ public String getUsage(ICommandSender sender) {
 
 	@Override
 	public void execute(MinecraftServer server, ICommandSender sender, String[] args) throws CommandException {
+		sender.sendMessage(new TextComponentString(TextFormatting.RED + "This feature does not work at the moment!"));
 		if (sender instanceof EntityPlayer) {
 			if (sender.canUseCommand(2, "load")) {
 				if (args.length < 1) {

src/main/java/com/minecrafttas/tasmod/commands/CommandPlay.java

@@ -38,7 +38,6 @@ public List<String> getAliases() {
 
 	@Override
 	public void execute(MinecraftServer server, ICommandSender sender, String[] args) throws CommandException {
-		sender.sendMessage(new TextComponentString(TextFormatting.RED + "This feature doesn't work at the moment!"));
 		if (!(sender instanceof EntityPlayer)) {
 			return;
 		}

src/main/java/com/minecrafttas/tasmod/commands/CommandRecord.java

@@ -38,7 +38,6 @@ public List<String> getAliases() {
 
 	@Override
 	public void execute(MinecraftServer server, ICommandSender sender, String[] args) throws CommandException {
-		sender.sendMessage(new TextComponentString(TextFormatting.RED + "This feature doesn't work at the moment!"));
 		if (!(sender instanceof EntityPlayer)) {
 			return;
 		}