Skip to content

Commit

Permalink
link to a specific revision for subscriber example
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam- authored Jan 13, 2024
1 parent c0b9b2c commit 4e3e7eb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Developer Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ Most plugins are comprised of only a few components:
- Overlays. Overlays all extend class Overlay, and have a `render()` method which you must override.
Overlays must be registered with the overlay manager on plugin startUp, and unregistered on shutDown.
`Overlay`s can draw anything they want anywhere on the game e.g. [AbyssOverlay](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/plugins/runecraft/AbyssOverlay.java), which draws clickboxes on game objects. Text boxes are made via `OverlayPanel` (e.g. [AttackStylesOverlay](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/plugins/attackstyles/AttackStylesOverlay.java)). `WidgetItemOverlay` draws on items.
- Event subscribers. These are methods annotated with `@Subscribe` and must be located in the plugin class. Events power most plugins in RuneLite, and it is how plugins react to things happening in the game, such as objects or npcs spawning, players sending messages, etc. Here is an [example](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/plugins/runecraft/RunecraftPlugin.java#L142-L150) of an event subscriber, checking to see if the spawned object is an abyssal rift. There are many events, and some plugins have their own events. Most events you can subscribe to can be found in the [api documentation](https://static.runelite.net/api/runelite-api/net/runelite/api/events/package-summary.html) and also [client documentation](https://static.runelite.net/api/runelite-client/net/runelite/client/events/package-summary.html).
- Event subscribers. These are methods annotated with `@Subscribe` and must be located in the plugin class. Events power most plugins in RuneLite, and it is how plugins react to things happening in the game, such as objects or npcs spawning, players sending messages, etc. Here is an [example](https://github.com/runelite/runelite/blob/runelite-parent-1.10.19/runelite-client/src/main/java/net/runelite/client/plugins/runecraft/RunecraftPlugin.java#L142-L150) of an event subscriber, checking to see if the spawned object is an abyssal rift. There are many events, and some plugins have their own events. Most events you can subscribe to can be found in the [api documentation](https://static.runelite.net/api/runelite-api/net/runelite/api/events/package-summary.html) and also [client documentation](https://static.runelite.net/api/runelite-client/net/runelite/client/events/package-summary.html).
- Plugin panels. These are [Swing](https://docs.oracle.com/javase/tutorial/uiswing/) panels on the client sidebar, such as the loot tracker and farming tracker. Here is an [example](https://github.com/runelite/runelite/blob/master/runelite-client/src/main/java/net/runelite/client/plugins/info/InfoPanel.java) of a plugin panel.

0 comments on commit 4e3e7eb

Please sign in to comment.