Class Events.ChatEvent
java.lang.Object
privbot.hooks.Events.ChatEvent
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal StringThe message text.final StringThe sender's name (may carry server markup), or "" for game messages.final booleanTrue when polled from the client's message list; false when forwarded.final intThe game tick it was seen on (-1 when unknown).final net.runelite.api.ChatMessageTypeThe message type, or null when unknown. -
Constructor Summary
ConstructorsConstructorDescriptionChatEvent(net.runelite.api.ChatMessageType type, String name, String message, int tick, boolean polled) A chat line without a client message-node id (de-duplicated by content within the tick).ChatEvent(net.runelite.api.ChatMessageType type, String name, String message, int tick, boolean polled, String key) A chat line with a stable identity (sources and tests). -
Method Summary
-
Field Details
-
type
public final net.runelite.api.ChatMessageType typeThe message type, or null when unknown. -
name
The sender's name (may carry server markup), or "" for game messages. -
message
The message text. -
tick
public final int tickThe game tick it was seen on (-1 when unknown). -
polled
public final boolean polledTrue when polled from the client's message list; false when forwarded.
-
-
Constructor Details
-
ChatEvent
public ChatEvent(net.runelite.api.ChatMessageType type, String name, String message, int tick, boolean polled) A chat line without a client message-node id (de-duplicated by content within the tick).- Parameters:
type- message type, or nullname- sendermessage- texttick- game tickpolled- whether it was polled
-
ChatEvent
public ChatEvent(net.runelite.api.ChatMessageType type, String name, String message, int tick, boolean polled, String key) A chat line with a stable identity (sources and tests).- Parameters:
type- message type, or nullname- sendermessage- texttick- game tickpolled- whether it was polledkey- stable identity (nodeKey(int)/contentKey(net.runelite.api.ChatMessageType, java.lang.String, java.lang.String, java.lang.String)), or null to derive one from the content and tick
-
-
Method Details
-
nodeKey
- Parameters:
nodeId- the client's message-node id- Returns:
- the de-duplication key for that node
-
contentKey
-
toString
-