generated from runelite/example-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
Refactor existing lifecycle into a more modular PluginModule #43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Infinitay
wants to merge
8
commits into
master
Choose a base branch
from
pluginmodule-refactor
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Created an abstract class PluginModule to better handle multiple modules within the plugin and to appropriately handle the lifecycle - Construct injected common fields such as OverlayManager, Client, and the config - Field injected on-demand fields such as EventBus and GameEventManager - Automatically (un)registers the module from the EventBus - Re-fire various events by utilizing GameEventManager#simulateGameEvents within #startUp - Abstracted #onStartUp to handle module starts, #onShutdown to handle module stops, and #isEnabled to determine the status of the module
…ycle - Removed prior injections that have yet to be refactored - Refactored #startUp, #shutDown, and #onConfigChanged to utilize the new modular system to handle state changes
…fecycle - Refactored SurpriseExamHelper to the modular plugin lifecycle - Now extends PluginModule and implements respective methods, moving the existing start/stop login there - Use constructor injection and removed duplicate field injections - Injected SurpriseExamHelper and added it to the pluginModulesMap
- Improved handling initial runs when (re)starting the plugin when already inside the Surprise Exam random event - Primarily for when the puzzle interface is already on screen
Owner
Author
feat(module): Created PluginModule class for modular plugin lifecycle
refactor: Start refactoring RandomEventHelper to modular plugin lifecycle
refactor(surpriseexam): Migrate SurpriseExamHelper to PluginModule lifecycle
feat(PluginModule): Add #isLoggedIn to check if the player is logged infeat(surpriseexam): Improve support for starting during active event
|
- Refactored PirateHelper to the modular plugin lifecycle - Now extends PluginModule and implements respective methods, moving the existing start/stop login there - Use constructor injection and removed duplicate field injections - Injected PirateHelper and added it to the pluginModulesMap
- Refactored MimeHelper to the modular plugin lifecycle - Now extends PluginModule and implements respective methods, moving the existing start/stop login there - Use constructor injection and removed duplicate field injections - Injected MimeHelper and added it to the pluginModulesMap
…, refactor - Improved handling initial runs when (re)starting the plugin when already inside the Mime random event - Primarily for when the emote button interface is already on screen - Change Mime text when undetermined emote answer - Use default font size for overlay - Refactored Mime animation checks and answer updating into #updateMimeAnimation
Owner
Author
refactor(captarnav): Migrate PirateHelper to PluginModule lifecycle
refactor(mime): Migrate MimeHelper to PluginModule lifecycle
feat(mime): Improve support for starting during active event, overlay, refactor
|
Owner
Author
|
Note, while testing the Mime module, I noticed that starting and stopping the refactored Gravedigger module (multiple times) seems to have overlay issues again when switching back to field injection for both overlays. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
enhancement
New feature or request
implementing
Actively working on this issue/PR
surprise-exam
Surprise Exam module
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is an attempt to better modularize my existing codebase and plugin lifecycle by using abstraction and primarily constructor injection. The few benefits to this refactor are:
Events Implemented and Tested
feat(module): Created PluginModule class for modular plugin lifecycle