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

Merge pull request #6660 from MagicfTail/Timestamp

Browse Source 
Add timestamp plugin
This commit is contained in:
Adam
2018-12-13 20:15:52 -05:00
committed by GitHub
parent 92d91b09ff 6b359efb30
commit 140794840a
10 changed files with 220 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
runelite-api/src/main/java/net/runelite/api/MessageNode.java
View File

@@ -29,6 +29,13 @@ package net.runelite.api;
*/
public interface MessageNode
{
/**
* Get the id for this message node
*
* @return
*/
int getId();
/**
* Gets the type of message.
*
@@ -95,4 +102,18 @@ public interface MessageNode
* @param runeLiteFormatMessage the new message format
*/
void setRuneLiteFormatMessage(String runeLiteFormatMessage);
/**
* Get the timestamp for the message, in seconds from the unix epoch.
*
* @return
*/
int getTimestamp();
/**
* Set the timestamp of the message
*
* @param timestamp
*/
void setTimestamp(int timestamp);
}

4
runelite-api/src/main/java/net/runelite/api/events/SetMessage.java
View File

@@ -36,4 +36,8 @@ public class SetMessage
* The new message value.
*/
private String value;
/**
* Timestamp of the message.
*/
private int timestamp;
}

2
runelite-client/src/main/java/net/runelite/client/chat/ChatMessageManager.java
View File

@@ -564,6 +564,8 @@ public class ChatMessageManager
// Update the message with RuneLite additions
line.setRuneLiteFormatMessage(message.getRuneLiteFormattedMessage());
line.setTimestamp(message.getTimestamp());
update(line);
}

1
runelite-client/src/main/java/net/runelite/client/chat/QueuedMessage.java
View File

@@ -37,4 +37,5 @@ public class QueuedMessage
private String name;
private String sender;
private String runeLiteFormattedMessage;
private int timestamp;
}

18
runelite-client/src/main/java/net/runelite/client/config/ChatColorConfig.java
View File

@@ -509,4 +509,22 @@ public interface ChatColorConfig extends Config
description = "Color of Friend Usernames in Public Chat (transparent)"
)
Color transparentPublicFriendUsernames();
//Plugin specific chat colours
@ConfigItem(
position = 88,
keyName = "opaqueTimestamp",
name = "Timestamps (opaque)",
description = "Colour of Timestamps from the Timestamps plugin (opaque)"
)
Color opaqueTimestamp();
@ConfigItem(
position = 89,
keyName = "transparentTimestamp",
name = "Timestamps (transparent)",
description = "Colour of Timestamps from the Timestamps plugin (transparent)"
)
Color transparentTimestamp();
}

1
runelite-client/src/main/java/net/runelite/client/plugins/chathistory/ChatHistoryPlugin.java
View File

@@ -100,6 +100,7 @@ public class ChatHistoryPlugin extends Plugin
.sender(message.getSender())
.value(nbsp(message.getValue()))
.runeLiteFormattedMessage(nbsp(message.getMessageNode().getRuneLiteFormatMessage()))
.timestamp(message.getTimestamp())
.build();
if (!messageQueue.contains(queuedMessage))

99
runelite-client/src/main/java/net/runelite/client/plugins/timestamp/TimestampPlugin.java Normal file
View File

@@ -0,0 +1,99 @@
/*
* Copyright (c) 2018, Magic fTail
* Copyright (c) 2018, Adam <Adam@sigterm.info>
* 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.timestamp;
import java.awt.Color;
import java.time.Instant;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.time.temporal.ChronoField;
import javax.inject.Inject;
import net.runelite.api.Client;
import net.runelite.api.MessageNode;
import net.runelite.api.Varbits;
import net.runelite.api.events.ScriptCallbackEvent;
import net.runelite.client.config.ChatColorConfig;
import net.runelite.client.eventbus.Subscribe;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
import net.runelite.client.util.ColorUtil;
@PluginDescriptor(
name = "Chat Timestamps",
description = "Add timestamps to chat messages",
tags = {"timestamp"},
enabledByDefault = false
)
public class TimestampPlugin extends Plugin
{
@Inject
private Client client;
@Inject
private ChatColorConfig chatColorConfig;
@Subscribe
public void onScriptCallbackEvent(ScriptCallbackEvent event)
{
if (!event.getEventName().equals("addTimestamp"))
{
return;
}
int[] intStack = client.getIntStack();
int intStackSize = client.getIntStackSize();
String[] stringStack = client.getStringStack();
int stringStackSize = client.getStringStackSize();
int messageId = intStack[intStackSize - 1];
MessageNode messageNode = (MessageNode) client.getMessages().get(messageId);
final ZonedDateTime time = ZonedDateTime.ofInstant(
Instant.ofEpochSecond(messageNode.getTimestamp()), ZoneId.systemDefault());
final String dateFormat = time.get(ChronoField.HOUR_OF_DAY) + ":" +
String.format("%02d", time.get(ChronoField.MINUTE_OF_HOUR));
String timestamp = "[" + dateFormat + "]";
Color timestampColour = getTimestampColour();
if (timestampColour != null)
{
timestamp = ColorUtil.wrapWithColorTag(timestamp, timestampColour);
}
stringStack[stringStackSize - 1] = timestamp;
}
private Color getTimestampColour()
{
boolean isChatboxTransparent = client.isResized() && client.getVar(Varbits.TRANSPARENT_CHATBOX) == 1;
return isChatboxTransparent ? chatColorConfig.transparentTimestamp() : chatColorConfig.opaqueTimestamp();
}
}

56
runelite-client/src/main/scripts/ChatBuilder.rs2asm
View File

@@ -216,9 +216,14 @@ LABEL183:
91: LABEL207
jump LABEL426
LABEL186:
iload 9 ; The id of the messageNode of the message being built
load_string ""
load_string "addTimestamp"
runelite_callback
pop_int
sload 9
load_string ":"
string_append 2
string_append 3 ; We need to append an extra string since we added the timestamp
sload 1
sload 11
load_string "</col>"
@@ -238,9 +243,14 @@ LABEL186:
istore 6
jump LABEL440
LABEL207:
iload 9 ; The id of the messageNode of the message being built
load_string ""
load_string "addTimestamp"
runelite_callback
pop_int
sload 9
load_string ":"
string_append 2
string_append 3 ; We need to append an extra string since we added the timestamp
sload 3
sload 11
load_string "</col>"
@@ -260,12 +270,17 @@ LABEL207:
istore 6
jump LABEL440
LABEL228:
iload 9 ; The id of the messageNode of the message being built
load_string ""
load_string "addTimestamp"
runelite_callback
pop_int
load_string "From "
sload 9
load_string ":"
load_string "privateChatFrom"
runelite_callback
string_append 3
string_append 4 ; We need to append an extra string since we added the timestamp
sload 2
sload 11
load_string "</col>"
@@ -285,10 +300,15 @@ LABEL228:
istore 6
jump LABEL440
LABEL250:
iload 9 ; The id of the messageNode of the message being built
load_string ""
load_string "addTimestamp"
runelite_callback
pop_int
sload 7
sload 11
load_string "</col>"
string_append 3
string_append 4 ; We need to append an extra string since we added the timestamp
iload 7
iload 8
load_int 10616890
@@ -304,10 +324,15 @@ LABEL250:
istore 6
jump LABEL440
LABEL268:
iload 9 ; The id of the messageNode of the message being built
load_string ""
load_string "addTimestamp"
runelite_callback
pop_int
sload 2
sload 11
load_string "</col>"
string_append 3
string_append 4 ; We need to append an extra string since we added the timestamp
iload 7
iload 8
load_int 10616890
@@ -340,12 +365,17 @@ LABEL289:
LABEL300:
jump LABEL440
LABEL301:
iload 9 ; The id of the messageNode of the message being built
load_string ""
load_string "addTimestamp"
runelite_callback
pop_int
load_string "To "
sload 9
load_string ":"
load_string "privateChatTo"
runelite_callback
string_append 3
string_append 4 ; We need to append an extra string since we added the timestamp
sload 2
sload 11
load_string "</col>"
@@ -365,10 +395,15 @@ LABEL301:
istore 6
jump LABEL440
LABEL323:
iload 9 ; The id of the messageNode of the message being built
load_string ""
load_string "addTimestamp"
runelite_callback
pop_int
sload 8
sload 11
load_string "</col>"
string_append 3
string_append 4 ; We need to append an extra string since we added the timestamp
iload 7
iload 8
load_int 10616890
@@ -384,6 +419,11 @@ LABEL323:
istore 6
jump LABEL440
LABEL341:
iload 9 ; The id of the messageNode of the message being built
load_string ""
load_string "addTimestamp"
runelite_callback
pop_int
load_string "["
sload 5
sload 10
@@ -391,7 +431,7 @@ LABEL341:
load_string "] "
sload 9
load_string ":"
string_append 7
string_append 8 ; We need to append an extra string since we added the timestamp
sload 6
sload 11
load_string "</col>"

22
runelite-mixins/src/main/java/net/runelite/mixins/RSMessageNodeMixin.java
View File

@@ -42,15 +42,21 @@ public abstract class RSMessageNodeMixin implements RSMessageNode
@Inject
private String runeLiteFormatMessage;
@Inject
private int rl$timestamp;
@Inject
RSMessageNodeMixin()
{
rl$timestamp = (int) (System.currentTimeMillis() / 1000L);
final SetMessage setMessage = new SetMessage();
setMessage.setMessageNode(this);
setMessage.setType(getType());
setMessage.setName(getName());
setMessage.setSender(getSender());
setMessage.setValue(getValue());
setMessage.setTimestamp(rl$timestamp);
client.getCallbacks().post(setMessage);
}
@@ -75,6 +81,20 @@ public abstract class RSMessageNodeMixin implements RSMessageNode
this.runeLiteFormatMessage = runeLiteFormatMessage;
}
@Inject
@Override
public int getTimestamp()
{
return rl$timestamp;
}
@Inject
@Override
public void setTimestamp(int timestamp)
{
this.rl$timestamp = timestamp;
}
@Inject
@MethodHook(value = "setMessage", end = true)
public void setMessage(int type, String name, String sender, String value)
@@ -82,6 +102,7 @@ public abstract class RSMessageNodeMixin implements RSMessageNode
// Message nodes get reused after a time by calling setMessage.
// Clear the runelite formatted message then.
runeLiteFormatMessage = null;
rl$timestamp = (int) (System.currentTimeMillis() / 1000L);
final SetMessage setMessage = new SetMessage();
setMessage.setMessageNode(this);
@@ -89,6 +110,7 @@ public abstract class RSMessageNodeMixin implements RSMessageNode
setMessage.setName(name);
setMessage.setSender(sender);
setMessage.setValue(value);
setMessage.setTimestamp(rl$timestamp);
client.getCallbacks().post(setMessage);
}
}

4
runescape-api/src/main/java/net/runelite/rs/api/RSMessageNode.java
View File

@@ -29,6 +29,10 @@ import net.runelite.mapping.Import;
public interface RSMessageNode extends MessageNode
{
@Import("id")
@Override
int getId();
@Import("type")
int getRSType();