forked from runelite/runelite
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add feature to pause skill timers on logout or after idle period
- Loading branch information
1 parent
aa8d2e5
commit f0e35fc
Showing
8 changed files
with
395 additions
and
41 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
104 changes: 104 additions & 0 deletions
104
runelite-client/src/main/java/net/runelite/client/plugins/xptracker/XpPauseState.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| /* | ||
| * Copyright (c) 2018, Levi <[email protected]> | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are met: | ||
| * | ||
| * 1. Redistributions of source code must retain the above copyright notice, this | ||
| * list of conditions and the following disclaimer. | ||
| * 2. Redistributions in binary form must reproduce the above copyright notice, | ||
| * this list of conditions and the following disclaimer in the documentation | ||
| * and/or other materials provided with the distribution. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | ||
| * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
| * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR | ||
| * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
| * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
| package net.runelite.client.plugins.xptracker; | ||
|
|
||
| import java.util.EnumMap; | ||
| import java.util.Map; | ||
| import net.runelite.api.Skill; | ||
|
|
||
| class XpPauseState | ||
| { | ||
| // Internal state | ||
| private final Map<Skill, XpPauseStateSingle> skillPauses = new EnumMap<>(Skill.class); | ||
| private boolean cachedIsLoggedIn = false; | ||
|
|
||
| boolean pauseSkill(Skill skill) | ||
| { | ||
| return findPauseState(skill).manualPause(); | ||
| } | ||
|
|
||
| boolean unpauseSkill(Skill skill) | ||
| { | ||
| return findPauseState(skill).unpause(); | ||
| } | ||
|
|
||
| boolean isPaused(Skill skill) | ||
| { | ||
| return findPauseState(skill).isPaused(); | ||
| } | ||
|
|
||
| void tickXp(Skill skill, int currentXp, int pauseAfterMinutes) | ||
| { | ||
| final XpPauseStateSingle state = findPauseState(skill); | ||
|
|
||
| if (state.getXp() != currentXp) | ||
| { | ||
| state.xpChanged(currentXp); | ||
| } | ||
| else if (pauseAfterMinutes > 0) | ||
| { | ||
| final long now = System.currentTimeMillis(); | ||
| final int pauseAfterMillis = pauseAfterMinutes * 60 * 1000; | ||
| final long lastChangeMillis = state.getLastChangeMillis(); | ||
| // When config.pauseSkillAfter is 0, it is effectively disabled | ||
| if (lastChangeMillis != 0 && (now - lastChangeMillis) >= pauseAfterMillis) | ||
| { | ||
| state.timeout(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| void tickLogout(boolean pauseOnLogout, boolean loggedIn) | ||
| { | ||
| // Deduplicated login and logout calls | ||
| if (!cachedIsLoggedIn && loggedIn) | ||
| { | ||
| cachedIsLoggedIn = true; | ||
|
|
||
| for (Skill skill : Skill.values()) | ||
| { | ||
| findPauseState(skill).login(); | ||
| } | ||
| } | ||
| else if (cachedIsLoggedIn && !loggedIn) | ||
| { | ||
| cachedIsLoggedIn = false; | ||
|
|
||
| // If configured, then let the pause state know to pause with reason: logout | ||
| if (pauseOnLogout) | ||
| { | ||
| for (Skill skill : Skill.values()) | ||
| { | ||
| findPauseState(skill).logout(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private XpPauseStateSingle findPauseState(Skill skill) | ||
| { | ||
| return skillPauses.computeIfAbsent(skill, XpPauseStateSingle::new); | ||
| } | ||
| } |
99 changes: 99 additions & 0 deletions
99
runelite-client/src/main/java/net/runelite/client/plugins/xptracker/XpPauseStateSingle.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| /* | ||
| * Copyright (c) 2018, Levi <[email protected]> | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are met: | ||
| * | ||
| * 1. Redistributions of source code must retain the above copyright notice, this | ||
| * list of conditions and the following disclaimer. | ||
| * 2. Redistributions in binary form must reproduce the above copyright notice, | ||
| * this list of conditions and the following disclaimer in the documentation | ||
| * and/or other materials provided with the distribution. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | ||
| * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
| * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR | ||
| * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
| * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
| * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
| package net.runelite.client.plugins.xptracker; | ||
|
|
||
| import java.util.EnumSet; | ||
| import java.util.Set; | ||
| import lombok.Getter; | ||
| import lombok.RequiredArgsConstructor; | ||
| import net.runelite.api.Skill; | ||
|
|
||
| @RequiredArgsConstructor | ||
| class XpPauseStateSingle | ||
| { | ||
| @Getter | ||
| private final Skill skill; | ||
| private final Set<XpPauseReason> pauseReasons = EnumSet.noneOf(XpPauseReason.class); | ||
| @Getter | ||
| private long lastChangeMillis; | ||
| @Getter | ||
| private int xp; | ||
|
|
||
| boolean isPaused() | ||
| { | ||
| return !pauseReasons.isEmpty(); | ||
| } | ||
|
|
||
| boolean login() | ||
| { | ||
| return pauseReasons.remove(XpPauseReason.PAUSED_LOGOUT); | ||
| } | ||
|
|
||
| boolean logout() | ||
| { | ||
| return pauseReasons.add(XpPauseReason.PAUSED_LOGOUT); | ||
| } | ||
|
|
||
| boolean timeout() | ||
| { | ||
| return pauseReasons.add(XpPauseReason.PAUSED_TIMEOUT); | ||
| } | ||
|
|
||
| boolean manualPause() | ||
| { | ||
| return pauseReasons.add(XpPauseReason.PAUSE_MANUAL); | ||
| } | ||
|
|
||
| boolean xpChanged(int xp) | ||
| { | ||
| this.xp = xp; | ||
| this.lastChangeMillis = System.currentTimeMillis(); | ||
| return clearAll(); | ||
| } | ||
|
|
||
| boolean unpause() | ||
| { | ||
| this.lastChangeMillis = System.currentTimeMillis(); | ||
| return clearAll(); | ||
| } | ||
|
|
||
| private boolean clearAll() | ||
| { | ||
| if (pauseReasons.isEmpty()) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| pauseReasons.clear(); | ||
| return true; | ||
| } | ||
|
|
||
| private enum XpPauseReason | ||
| { | ||
| PAUSE_MANUAL, | ||
| PAUSED_LOGOUT, | ||
| PAUSED_TIMEOUT | ||
| } | ||
| } |
This file contains 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
Oops, something went wrong.