ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Add interface representing all callbacks the client does, and convert mixins to use it

Browse Source 
This allows creating and injecting Hooks via guice
This commit is contained in:
Adam
2018-06-22 22:36:39 -04:00
parent ab936a6cdb
commit f0da475370
31 changed files with 408 additions and 282 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
runelite-client/src/main/java/net/runelite/client/RuneLite.java
View File

@@ -217,6 +217,9 @@ public class RuneLite
if (!isOutdated)
{
this.client = (Client) client;
// Inject members into client
injector.injectMembers(client);
}
// Initialize UI

16
runelite-client/src/main/java/net/runelite/client/RuneLiteModule.java
View File

@@ -28,12 +28,15 @@ import com.google.common.eventbus.EventBus;
import com.google.common.eventbus.SubscriberExceptionContext;
import com.google.inject.AbstractModule;
import com.google.inject.Provides;
import com.google.inject.name.Names;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import javax.inject.Singleton;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.Client;
import net.runelite.api.hooks.Callbacks;
import net.runelite.client.account.SessionManager;
import net.runelite.client.callback.Hooks;
import net.runelite.client.chat.ChatMessageManager;
import net.runelite.client.config.ChatColorConfig;
import net.runelite.client.config.ConfigManager;
@@ -42,7 +45,10 @@ import net.runelite.client.game.ItemManager;
import net.runelite.client.menus.MenuManager;
import net.runelite.client.plugins.PluginManager;
import net.runelite.client.task.Scheduler;
import net.runelite.client.util.DeferredEventBus;
import net.runelite.client.util.QueryRunner;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@Slf4j
public class RuneLiteModule extends AbstractModule
@@ -59,6 +65,16 @@ public class RuneLiteModule extends AbstractModule
bind(PluginManager.class);
bind(RuneLiteProperties.class);
bind(SessionManager.class);
bind(Callbacks.class).to(Hooks.class);
bind(EventBus.class)
.annotatedWith(Names.named("Deferred EventBus"))
.to(DeferredEventBus.class);
bind(Logger.class)
.annotatedWith(Names.named("Core Logger"))
.toInstance(LoggerFactory.getLogger(RuneLite.class));
}
@Provides

145
runelite-client/src/main/java/net/runelite/client/callback/Hooks.java
View File

@@ -38,11 +38,15 @@ import java.awt.event.MouseEvent;
import java.awt.event.MouseWheelEvent;
import java.awt.image.BufferedImage;
import java.awt.image.VolatileImage;
import javax.inject.Inject;
import javax.inject.Singleton;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.Client;
import net.runelite.api.MainBufferProvider;
import net.runelite.api.RenderOverview;
import net.runelite.api.WorldMapManager;
import net.runelite.api.events.GameTick;
import net.runelite.api.hooks.Callbacks;
import net.runelite.api.widgets.Widget;
import static net.runelite.api.widgets.WidgetInfo.WORLD_MAP_VIEW;
import net.runelite.client.Notifier;
@@ -57,54 +61,86 @@ import net.runelite.client.ui.overlay.OverlayLayer;
import net.runelite.client.ui.overlay.OverlayRenderer;
import net.runelite.client.ui.overlay.infobox.InfoBoxManager;
import net.runelite.client.util.DeferredEventBus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This class contains field required for mixins and runelite hooks to work.
* All remaining method hooks in this class are performance-critical or contain client-specific logic and so they
* can't just be placed in mixins or sent through event bus.
*/
public class Hooks
@Singleton
@Slf4j
public class Hooks implements Callbacks
{
// must be public as the mixins use it
public static final Logger log = LoggerFactory.getLogger(Hooks.class);
private static final long CHECK = 600; // ms - how often to run checks
private static final Injector injector = RuneLite.getInjector();
private static final Client client = injector.getInstance(Client.class);
public static final EventBus eventBus = injector.getInstance(EventBus.class); // symbol must match mixin Hook
private static final DeferredEventBus _deferredEventBus = injector.getInstance(DeferredEventBus.class);
public static final EventBus deferredEventBus = _deferredEventBus; // symbol must match mixin Hook
private static final Scheduler scheduler = injector.getInstance(Scheduler.class);
private static final InfoBoxManager infoBoxManager = injector.getInstance(InfoBoxManager.class);
private static final ChatMessageManager chatMessageManager = injector.getInstance(ChatMessageManager.class);
private static final OverlayRenderer renderer = injector.getInstance(OverlayRenderer.class);
private static final MouseManager mouseManager = injector.getInstance(MouseManager.class);
private static final KeyManager keyManager = injector.getInstance(KeyManager.class);
private static final ClientThread clientThread = injector.getInstance(ClientThread.class);
private static final GameTick tick = new GameTick();
private static final DrawManager renderHooks = injector.getInstance(DrawManager.class);
private static final Notifier notifier = injector.getInstance(Notifier.class);
private static final ClientUI clientUi = injector.getInstance(ClientUI.class);
private static Dimension lastStretchedDimensions;
private static VolatileImage stretchedImage;
private static Graphics2D stretchedGraphics;
private static final GameTick GAME_TICK = new GameTick();
private static long lastCheck;
private static boolean shouldProcessGameTick;
@Inject
private EventBus eventBus;
public static void clientMainLoop()
@Inject
private DeferredEventBus deferredEventBus;
@Inject
private Scheduler scheduler;
@Inject
private InfoBoxManager infoBoxManager;
@Inject
private ChatMessageManager chatMessageManager;
@Inject
private MouseManager mouseManager;
@Inject
private KeyManager keyManager;
@Inject
private ClientThread clientThread;
@Inject
private DrawManager drawManager;
@Inject
private Notifier notifier;
@Inject
private ClientUI clientUi;
private Dimension lastStretchedDimensions;
private VolatileImage stretchedImage;
private Graphics2D stretchedGraphics;
private long lastCheck;
private boolean shouldProcessGameTick;
@Override
public void post(Object event)
{
eventBus.post(event);
}
@Override
public void postDeferred(Object event)
{
deferredEventBus.post(event);
}
@Override
public void clientMainLoop()
{
if (shouldProcessGameTick)
{
shouldProcessGameTick = false;
_deferredEventBus.replay();
deferredEventBus.replay();
eventBus.post(tick);
eventBus.post(GAME_TICK);
int tick = client.getTickCount();
client.setTickCount(tick + 1);
@@ -147,7 +183,7 @@ public class Hooks
* data to be garbage collecged, and causes the map data from disk each time
* is it opened.
*/
private static void checkWorldMap()
private void checkWorldMap()
{
Widget widget = client.getWidget(WORLD_MAP_VIEW);
@@ -172,62 +208,74 @@ public class Hooks
}
}
public static MouseEvent mousePressed(MouseEvent mouseEvent)
@Override
public MouseEvent mousePressed(MouseEvent mouseEvent)
{
return mouseManager.processMousePressed(mouseEvent);
}
public static MouseEvent mouseReleased(MouseEvent mouseEvent)
@Override
public MouseEvent mouseReleased(MouseEvent mouseEvent)
{
return mouseManager.processMouseReleased(mouseEvent);
}
public static MouseEvent mouseClicked(MouseEvent mouseEvent)
@Override
public MouseEvent mouseClicked(MouseEvent mouseEvent)
{
return mouseManager.processMouseClicked(mouseEvent);
}
public static MouseEvent mouseEntered(MouseEvent mouseEvent)
@Override
public MouseEvent mouseEntered(MouseEvent mouseEvent)
{
return mouseManager.processMouseEntered(mouseEvent);
}
public static MouseEvent mouseExited(MouseEvent mouseEvent)
@Override
public MouseEvent mouseExited(MouseEvent mouseEvent)
{
return mouseManager.processMouseExited(mouseEvent);
}
public static MouseEvent mouseDragged(MouseEvent mouseEvent)
@Override
public MouseEvent mouseDragged(MouseEvent mouseEvent)
{
return mouseManager.processMouseDragged(mouseEvent);
}
public static MouseEvent mouseMoved(MouseEvent mouseEvent)
@Override
public MouseEvent mouseMoved(MouseEvent mouseEvent)
{
return mouseManager.processMouseMoved(mouseEvent);
}
public static MouseWheelEvent mouseWheelMoved(MouseWheelEvent event)
@Override
public MouseWheelEvent mouseWheelMoved(MouseWheelEvent event)
{
return mouseManager.processMouseWheelMoved(event);
}
public static void keyPressed(KeyEvent keyEvent)
@Override
public void keyPressed(KeyEvent keyEvent)
{
keyManager.processKeyPressed(keyEvent);
}
public static void keyReleased(KeyEvent keyEvent)
@Override
public void keyReleased(KeyEvent keyEvent)
{
keyManager.processKeyReleased(keyEvent);
}
public static void keyTyped(KeyEvent keyEvent)
@Override
public void keyTyped(KeyEvent keyEvent)
{
keyManager.processKeyTyped(keyEvent);
}
public static void draw(MainBufferProvider mainBufferProvider, Graphics graphics, int x, int y)
@Override
public void draw(MainBufferProvider mainBufferProvider, Graphics graphics, int x, int y)
{
if (graphics == null)
{
@@ -278,9 +326,9 @@ public class Hooks
}
stretchedGraphics.setRenderingHint(RenderingHints.KEY_INTERPOLATION,
client.isStretchedFast()
? RenderingHints.VALUE_INTERPOLATION_NEAREST_NEIGHBOR
: RenderingHints.VALUE_INTERPOLATION_BILINEAR);
client.isStretchedFast()
? RenderingHints.VALUE_INTERPOLATION_NEAREST_NEIGHBOR
: RenderingHints.VALUE_INTERPOLATION_BILINEAR);
stretchedGraphics.drawImage(image, 0, 0, stretchedDimensions.width, stretchedDimensions.height, null);
image = stretchedImage;
@@ -289,10 +337,11 @@ public class Hooks
// Draw the image onto the game canvas
graphics.drawImage(image, 0, 0, client.getCanvas());
renderHooks.processDrawComplete(image);
drawManager.processDrawComplete(image);
}
public static void drawRegion()
@Override
public void drawRegion()
{
MainBufferProvider bufferProvider = (MainBufferProvider) client.getBufferProvider();
BufferedImage image = (BufferedImage) bufferProvider.getImage();
@@ -308,7 +357,8 @@ public class Hooks
}
}
public static void drawAboveOverheads()
@Override
public void drawAboveOverheads()
{
MainBufferProvider bufferProvider = (MainBufferProvider) client.getBufferProvider();
BufferedImage image = (BufferedImage) bufferProvider.getImage();
@@ -340,7 +390,8 @@ public class Hooks
}
}
public static void updateNpcs()
@Override
public void updateNpcs()
{
// The NPC update event seem to run every server tick,
// but having the game tick event after all packets