DIvan2000/ReplayModCinematic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix keybinding conflicts on 1.14+ (fixes #268)

Browse Source 
This fixes both, replay-exclusive keybindings blocking vanilla ones as well as
vanilla keybindings blocking replay-exclusive ones.

The magic happens in Mixin_ContextualKeyBindings.
This commit is contained in:
Jonas Herzig
2020-07-25 21:34:30 +02:00
parent 063657af4c
commit fd7b6030f9
11 changed files with 105 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/main/java/com/replaymod/core/KeyBindingRegistry.java
View File

@@ -35,7 +35,9 @@ import org.lwjgl.glfw.GLFW;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
public class KeyBindingRegistry extends EventRegistrations {
private static final String CATEGORY = "replaymod.title";
@@ -44,19 +46,20 @@ public class KeyBindingRegistry extends EventRegistrations {
//#endif
private Map<String, KeyBinding> keyBindings = new HashMap<String, KeyBinding>();
private Set<KeyBinding> onlyInReplay = new HashSet<>();
private Multimap<KeyBinding, Runnable> keyBindingHandlers = ArrayListMultimap.create();
private Multimap<KeyBinding, Runnable> repeatedKeyBindingHandlers = ArrayListMultimap.create();
private Multimap<Integer, Runnable> rawHandlers = ArrayListMultimap.create();
public void registerKeyBinding(String name, int keyCode, Runnable whenPressed) {
keyBindingHandlers.put(registerKeyBinding(name, keyCode), whenPressed);
public void registerKeyBinding(String name, int keyCode, Runnable whenPressed, boolean onlyInRepay) {
keyBindingHandlers.put(registerKeyBinding(name, keyCode, onlyInRepay), whenPressed);
}
public void registerRepeatedKeyBinding(String name, int keyCode, Runnable whenPressed) {
repeatedKeyBindingHandlers.put(registerKeyBinding(name, keyCode), whenPressed);
public void registerRepeatedKeyBinding(String name, int keyCode, Runnable whenPressed, boolean onlyInRepay) {
repeatedKeyBindingHandlers.put(registerKeyBinding(name, keyCode, onlyInRepay), whenPressed);
}
private KeyBinding registerKeyBinding(String name, int keyCode) {
private KeyBinding registerKeyBinding(String name, int keyCode, boolean onlyInRepay) {
KeyBinding keyBinding = keyBindings.get(name);
if (keyBinding == null) {
//#if FABRIC>=1
@@ -72,6 +75,11 @@ public class KeyBindingRegistry extends EventRegistrations {
//$$ ClientRegistry.registerKeyBinding(keyBinding);
//#endif
keyBindings.put(name, keyBinding);
if (onlyInRepay) {
this.onlyInReplay.add(keyBinding);
}
} else if (!onlyInRepay) {
this.onlyInReplay.remove(keyBinding);
}
return keyBinding;
}
@@ -84,6 +92,10 @@ public class KeyBindingRegistry extends EventRegistrations {
return Collections.unmodifiableMap(keyBindings);
}
public Set<KeyBinding> getOnlyInReplay() {
return Collections.unmodifiableSet(onlyInReplay);
}
//#if MC>=11400
{ on(KeyBindingEventCallback.EVENT, this::handleKeyBindings); }
{ on(KeyEventCallback.EVENT, (keyCode, scanCode, action, modifiers) -> handleRaw(keyCode, action)); }

2
src/main/java/com/replaymod/core/ReplayMod.java
View File

@@ -318,7 +318,7 @@ public class ReplayMod implements
public void registerKeyBindings(KeyBindingRegistry registry) {
registry.registerKeyBinding("replaymod.input.settings", 0, () -> {
new GuiReplaySettings(null, settingsRegistry).display();
});
}, false);
}
@Override

63
src/main/java/com/replaymod/core/mixin/Mixin_ContextualKeyBindings.java Normal file
View File

@@ -0,0 +1,63 @@
//#if MC>=11400
package com.replaymod.core.mixin;
import com.replaymod.core.ReplayMod;
import com.replaymod.replay.ReplayModReplay;
import net.minecraft.client.options.KeyBinding;
import org.spongepowered.asm.mixin.Final;
import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.Shadow;
import org.spongepowered.asm.mixin.Unique;
import org.spongepowered.asm.mixin.injection.At;
import org.spongepowered.asm.mixin.injection.Inject;
import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* We have bunch of keybindings which only have an effect while in a replay but heavily conflict with vanilla ones
* otherwise. To work around this, we prevent our keybindings (or conflicting ones) from making it into the keysByCode
* map, depending on the current context.
*/
@Mixin(KeyBinding.class)
public class Mixin_ContextualKeyBindings {
@Shadow @Final private static Map<String, KeyBinding> keysById;
@Unique private static final List<KeyBinding> temporarilyRemoved = new ArrayList<>();
@Inject(method = "updateKeysByCode", at = @At("HEAD"))
private static void preContextualKeyBindings(CallbackInfo ci) {
Set<KeyBinding> onlyInReplay = ReplayMod.instance.getKeyBindingRegistry().getOnlyInReplay();
if (ReplayModReplay.instance.getReplayHandler() != null) {
// In replay, remove any conflicting key bindings, so that ours are guaranteed in
Mixin_ContextualKeyBindings.keysById.values().removeIf(keyBinding -> {
for (KeyBinding exclusiveBinding : onlyInReplay) {
if (keyBinding.equals(exclusiveBinding) && keyBinding != exclusiveBinding) {
temporarilyRemoved.add(keyBinding);
return true;
}
}
return false;
});
} else {
// Not in a replay, remove all replay-exclusive keybindings
for (KeyBinding keyBinding : onlyInReplay) {
if (Mixin_ContextualKeyBindings.keysById.remove(keyBinding.getId()) != null) {
temporarilyRemoved.add(keyBinding);
}
}
}
}
@Inject(method = "updateKeysByCode", at = @At("RETURN"))
private static void postContextualKeyBindings(CallbackInfo ci) {
for (KeyBinding keyBinding : temporarilyRemoved) {
Mixin_ContextualKeyBindings.keysById.put(keyBinding.getId(), keyBinding);
}
temporarilyRemoved.clear();
}
}
//#endif

2
src/main/java/com/replaymod/extras/FullBrightness.java
View File

@@ -53,7 +53,7 @@ public class FullBrightness extends EventRegistrations implements Extra {
updateIndicator(replayHandler.getOverlay());
}
}
});
}, true);
register();
}

2
src/main/java/com/replaymod/extras/playeroverview/PlayerOverview.java
View File

@@ -93,7 +93,7 @@ public class PlayerOverview extends EventRegistrations implements Extra {
new PlayerOverviewGui(PlayerOverview.this, players).display();
}
}
});
}, true);
register();
}

2
src/main/java/com/replaymod/recording/ReplayModRecording.java
View File

@@ -58,7 +58,7 @@ public class ReplayModRecording implements Module {
core.printInfoToChat("replaymod.chat.addedmarker");
}
}
});
}, false);
}
@Override

2
src/main/java/com/replaymod/replay/ReplayHandler.java
View File

@@ -237,7 +237,7 @@ public class ReplayHandler {
//#endif
overlay.setVisible(false);
ReplayModReplay.instance.replayHandler = null;
ReplayModReplay.instance.forcefullyStopReplay();
mc.openScreen(null);

23
src/main/java/com/replaymod/replay/ReplayModReplay.java
View File

@@ -23,6 +23,7 @@ import com.replaymod.replaystudio.replay.ReplayFile;
import com.replaymod.replaystudio.replay.ZipReplayFile;
import com.replaymod.replaystudio.studio.ReplayStudio;
import net.minecraft.client.MinecraftClient;
import net.minecraft.client.options.KeyBinding;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
@@ -46,7 +47,7 @@ public class ReplayModReplay implements Module {
public static Logger LOGGER = LogManager.getLogger();
protected ReplayHandler replayHandler;
private ReplayHandler replayHandler;
public ReplayHandler getReplayHandler() {
return replayHandler;
@@ -78,7 +79,7 @@ public class ReplayModReplay implements Module {
}
}
}
});
}, true);
registry.registerKeyBinding("replaymod.input.thumbnail", Keyboard.KEY_N, new Runnable() {
@Override
@@ -113,7 +114,7 @@ public class ReplayModReplay implements Module {
});
}
}
});
}, true);
registry.registerKeyBinding("replaymod.input.playpause", Keyboard.KEY_P, new Runnable() {
@Override
@@ -122,7 +123,7 @@ public class ReplayModReplay implements Module {
replayHandler.getOverlay().playPauseButton.onClick();
}
}
});
}, true);
registry.registerKeyBinding("replaymod.input.quickmode", Keyboard.KEY_Q, () -> {
if (replayHandler != null) {
@@ -133,19 +134,19 @@ public class ReplayModReplay implements Module {
replayHandler.getReplaySender().setAsyncMode(true);
}));
}
});
}, true);
core.getKeyBindingRegistry().registerKeyBinding("replaymod.input.rollclockwise", Keyboard.KEY_L, () -> {
// Noop, actual handling logic in CameraEntity#update
});
}, true);
core.getKeyBindingRegistry().registerKeyBinding("replaymod.input.rollcounterclockwise", Keyboard.KEY_J, () -> {
// Noop, actual handling logic in CameraEntity#update
});
}, true);
core.getKeyBindingRegistry().registerKeyBinding("replaymod.input.resettilt", Keyboard.KEY_K, () -> {
Optional.ofNullable(replayHandler).map(ReplayHandler::getCameraEntity).ifPresent(c -> c.roll = 0);
});
}, true);
}
@Override
@@ -191,10 +192,16 @@ public class ReplayModReplay implements Module {
}
}
replayHandler = new ReplayHandler(replayFile, true);
//#if MC>=11400
KeyBinding.updateKeysByCode(); // see Mixin_ContextualKeyBindings
//#endif
}
public void forcefullyStopReplay() {
replayHandler = null;
//#if MC>=11400
KeyBinding.updateKeysByCode(); // see Mixin_ContextualKeyBindings
//#endif
}
public ReplayMod getCore() {

6
src/main/java/com/replaymod/simplepathing/ReplayModSimplePathing.java
View File

@@ -82,13 +82,13 @@ public class ReplayModSimplePathing extends EventRegistrations implements Module
pathPreview.registerKeyBindings(registry);
core.getKeyBindingRegistry().registerKeyBinding("replaymod.input.keyframerepository", Keyboard.KEY_X, () -> {
if (guiPathing != null) guiPathing.keyframeRepoButtonPressed();
});
}, true);
core.getKeyBindingRegistry().registerKeyBinding("replaymod.input.clearkeyframes", Keyboard.KEY_C, () -> {
if (guiPathing != null) guiPathing.clearKeyframesButtonPressed();
});
}, true);
core.getKeyBindingRegistry().registerRepeatedKeyBinding("replaymod.input.synctimeline", Keyboard.KEY_V, () -> {
if (guiPathing != null) guiPathing.syncTimeButtonPressed();
});
}, true);
core.getKeyBindingRegistry().registerRaw(Keyboard.KEY_DELETE, () -> {
if (guiPathing != null) guiPathing.deleteButtonPressed();
});

2
src/main/java/com/replaymod/simplepathing/preview/PathPreview.java
View File

@@ -42,7 +42,7 @@ public class PathPreview extends EventRegistrations {
SettingsRegistry settings = mod.getCore().getSettingsRegistry();
settings.set(Setting.PATH_PREVIEW, !settings.get(Setting.PATH_PREVIEW));
settings.save();
});
}, true);
}
private void update() {

1
src/main/resources/mixins.core.replaymod.json
View File

@@ -6,6 +6,7 @@
"client": [
//#if MC>=11400
"AbstractButtonWidgetAccessor",
"Mixin_ContextualKeyBindings",
"MixinGameRenderer",
"MixinModResourcePackUtil",
//#endif