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

Merge pull request #1068 from Infinitay/daily-task-indicators

Browse Source 
Add daily task indicators
This commit is contained in:
Adam
2018-03-25 18:39:27 -04:00
committed by GitHub
parent 7b0859a8b5 b0cf1fe57f
commit cddf93ab51
3 changed files with 244 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
runelite-api/src/main/java/net/runelite/api/Varbits.java
View File

@@ -282,7 +282,14 @@ public enum Varbits
* Kingdom Management
*/
KINGDOM_FAVOR(72),
KINGDOM_COFFER(74);
KINGDOM_COFFER(74),
/**
* Daily Tasks (Collection availability)
*/
DAILY_HERB_BOX(3961),
DAILY_STAVES(4539),
DAILY_ESSENCE(4547);
/**
* varbit id

73
runelite-client/src/main/java/net/runelite/client/plugins/dailytaskindicators/DailyTasksConfig.java Normal file
View File

@@ -0,0 +1,73 @@
/*
* Copyright (c) 2018, Infinitay <https://github.com/Infinitay>
* 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.dailytaskindicators;
import net.runelite.client.config.Config;
import net.runelite.client.config.ConfigGroup;
import net.runelite.client.config.ConfigItem;
@ConfigGroup(
keyName = "dailytaskindicators",
name = "Daily Task Indicators",
description = "Configuration for Daily Task Indicators plugin"
)
public interface DailyTasksConfig extends Config
{
@ConfigItem(
keyName = "showHerbBoxes",
name = "Show Herb Boxes",
description = "Configures whether or not to show a message when you can" +
" collect your daily herb boxes at NMZ",
position = 1
)
default boolean showHerbBoxes()
{
return true;
}
@ConfigItem(
keyName = "showStaves",
name = "Show Claimable Staves",
description = "Configures whether or not to show a message when you can" +
" collect your daily staves from Zaff",
position = 2
)
default boolean showStaves()
{
return true;
}
@ConfigItem(
keyName = "showEssence",
name = "Show Claimable Essence",
description = "Configures whether or not to show a message when you can" +
" collect your daily pure essence from Wizard Cromperty",
position = 3
)
default boolean showEssence()
{
return true;
}
}

163
runelite-client/src/main/java/net/runelite/client/plugins/dailytaskindicators/DailyTasksPlugin.java Normal file
View File

@@ -0,0 +1,163 @@
/*
* Copyright (c) 2018, Infinitay <https://github.com/Infinitay>
* 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.dailytaskindicators;
import com.google.common.eventbus.Subscribe;
import com.google.inject.Provides;
import java.awt.Color;
import javax.inject.Inject;
import lombok.extern.slf4j.Slf4j;
import net.runelite.api.ChatMessageType;
import net.runelite.api.Client;
import net.runelite.api.GameState;
import net.runelite.api.Varbits;
import net.runelite.api.events.ConfigChanged;
import net.runelite.api.events.GameStateChanged;
import net.runelite.client.chat.ChatColor;
import net.runelite.client.chat.ChatColorType;
import net.runelite.client.chat.ChatMessageBuilder;
import net.runelite.client.chat.ChatMessageManager;
import net.runelite.client.chat.QueuedMessage;
import net.runelite.client.config.ConfigManager;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
@PluginDescriptor(
name = "Daily Task Indicator"
)
@Slf4j
public class DailyTasksPlugin extends Plugin
{
@Inject
private Client client;
@Inject
private DailyTasksConfig config;
@Inject
private ChatMessageManager chatMessageManager;
private boolean hasSentHerbMsg, hasSentStavesMsg, hasSentEssenceMsg;
@Provides
DailyTasksConfig provideConfig(ConfigManager configManager)
{
return configManager.getConfig(DailyTasksConfig.class);
}
@Override
protected void startUp() throws Exception
{
hasSentHerbMsg = hasSentStavesMsg = hasSentEssenceMsg = false;
cacheColors();
}
@Override
protected void shutDown() throws Exception
{
hasSentHerbMsg = hasSentStavesMsg = hasSentEssenceMsg = false;
}
@Subscribe
public void onConfigChanged(ConfigChanged event)
{
if (event.getGroup().equals("dailytaskindicators"))
{
if (event.getKey().equals("showHerbBoxes"))
{
hasSentHerbMsg = false;
}
else if (event.getKey().equals("showStaves"))
{
hasSentStavesMsg = false;
}
else if (event.getKey().equals("showEssence"))
{
hasSentEssenceMsg = false;
}
}
}
@Subscribe
public void onGameStateChanged(GameStateChanged event)
{
if (event.getGameState().equals(GameState.LOGGED_IN))
{
if (config.showHerbBoxes() && !hasSentHerbMsg && checkCanCollectHerbBox())
{
sendChatMessage("You have herb boxes waiting to be collected at NMZ.");
hasSentHerbMsg = true;
}
if (config.showStaves() && !hasSentStavesMsg && checkCanCollectStaves())
{
sendChatMessage("You have staves waiting to be collected from Zaff.");
hasSentStavesMsg = true;
}
if (config.showEssence() && !hasSentEssenceMsg && checkCanCollectEssence())
{
sendChatMessage("You have pure essence waiting to be collected from Wizard Cromperty.");
hasSentEssenceMsg = true;
}
}
}
private boolean checkCanCollectHerbBox()
{
int value = client.getSetting(Varbits.DAILY_HERB_BOX);
return value < 15; // < 15 can claim
}
private boolean checkCanCollectStaves()
{
int value = client.getSetting(Varbits.DAILY_STAVES);
return value == 0; // 1 = can't claim
}
private boolean checkCanCollectEssence()
{
int value = client.getSetting(Varbits.DAILY_ESSENCE);
return value < 0; // 1 = can't claim
}
private void cacheColors()
{
chatMessageManager.cacheColor(new ChatColor(ChatColorType.HIGHLIGHT, Color.RED, false), ChatMessageType.GAME).refreshAll();
}
private void sendChatMessage(String chatMessage)
{
final String message = new ChatMessageBuilder()
.append(ChatColorType.HIGHLIGHT)
.append(chatMessage)
.build();
chatMessageManager.queue(
QueuedMessage.builder()
.type(ChatMessageType.GAME)
.runeLiteFormattedMessage(message)
.build());
}
}