Skip to content

Add separate events for local and global chat#4683

Merged
mdcfe merged 4 commits intoEssentialsX:2.xfrom
brawaru:feat/add-chat-type-events
Feb 13, 2023
Merged

Add separate events for local and global chat#4683
mdcfe merged 4 commits intoEssentialsX:2.xfrom
brawaru:feat/add-chat-type-events

Conversation

@brawaru
Copy link
Copy Markdown
Contributor

@brawaru brawaru commented Dec 12, 2021 •
edited
Loading

Information

This PR helps DiscordSRV/DiscordSRV#1223.

Details

Proposed feature:

This PR adds two new events: GlobalChatEvent and LocalChatEvent, which allow other plugin developers to know whether the message sent is a global or local one and act accordingly. If either of those events is cancelled, then the source event is cancelled too.

Since all chat-related events share the same structure, a new abstract class ChatEvent is created with the change made for LocalChatSpyEvent to use it without breaking its API.

Environments tested:

OS: Windows 10 20H2.

Java version:

openjdk version "17" 2021-09-14 LTS
OpenJDK Runtime Environment Zulu17.28+13-CA (build 17+35-LTS)
OpenJDK 64-Bit Server VM Zulu17.28+13-CA (build 17+35-LTS, mixed mode, sharing)
  • Most recent Paper version (1.18.1, git-Paper-71)
  • CraftBukkit/Spigot/Paper 1.12.2
  • CraftBukkit 1.8.8

Demonstration:

Following this pull request, a draft pull request with the use of that API in Essentials Discord module was created — #4684.

@brawaru brawaru mentioned this pull request Dec 12, 2021
Merged
3 tasks
brawaru
brawaru commented Dec 12, 2021
View reviewed changes
Comment thread Essentials/src/main/java/net/ess3/api/events/LocalChatSpyEvent.java Outdated
@brawaru brawaru force-pushed the feat/add-chat-type-events branch from 842e9fb to 45a0678 Compare December 12, 2021 22:59
@triagonal triagonal added module: chat Issues or PRs for the EssentialsChat module type: api Issue/Pull Request regards user-facing API labels Dec 15, 2021
@brawaru brawaru force-pushed the feat/add-chat-type-events branch from 45a0678 to bc14df3 Compare February 14, 2022 08:36
JRoy
JRoy requested changes Mar 27, 2022
View reviewed changes
Comment thread Essentials/src/main/java/net/ess3/api/events/LocalChatSpyEvent.java Outdated
Comment thread ...tialsChat/src/main/java/com/earth2me/essentials/chat/EssentialsChatPlayerListenerNormal.java Outdated
Comment thread EssentialsChat/src/main/java/com/earth2me/essentials/chat/ChatStore.java Outdated
Comment thread ...tialsChat/src/main/java/com/earth2me/essentials/chat/EssentialsChatPlayerListenerNormal.java Outdated
@brawaru brawaru force-pushed the feat/add-chat-type-events branch from 18f24f7 to f9e6f52 Compare April 2, 2022 18:23
@brawaru
Copy link
Copy Markdown
Contributor Author

brawaru commented Apr 2, 2022 •
edited
Loading

Hello and thanks for the review! Sorry it took some time, but all noted issues should be fixed now.

@brawaru brawaru force-pushed the feat/add-chat-type-events branch from f9e6f52 to 1bf775e Compare June 1, 2022 03:08
@brawaru brawaru force-pushed the feat/add-chat-type-events branch from 1bf775e to a0fc04c Compare June 16, 2022 07:27
JRoy
JRoy requested changes Jul 5, 2022
View reviewed changes
Comment thread Essentials/src/main/java/net/essentialsx/api/v2/events/ChatEvent.java Outdated
Comment thread Essentials/src/main/java/net/essentialsx/api/v2/events/GlobalChatEvent.java Outdated
Comment thread Essentials/src/main/java/net/essentialsx/api/v2/events/LocalChatEvent.java Outdated
@brawaru brawaru force-pushed the feat/add-chat-type-events branch from 21b8556 to 0cd4898 Compare July 6, 2022 19:47
@brawaru
Copy link
Copy Markdown
Contributor Author

brawaru commented Jul 6, 2022

Rebased and moved new event classes to net.essentialsx.api.v2.events.chat 👍🏻

JRoy
JRoy previously approved these changes Jul 6, 2022
View reviewed changes
@JRoy JRoy added this to the 2.20.0 milestone Jul 6, 2022
@mdcfe
Copy link
Copy Markdown
Member

mdcfe commented Aug 16, 2022 •
edited
Loading

Hey, apologies for the slow response on this. We recently refactored EssentialsX Chat, so this PR will need need to be updated this PR accordingly (ie moving the callChatEvent method and call into AbstractChatHandler) before it can be merged. Aside from this, the PR looks good! If you'd like to update the PR, we would greatly appreciate it, but otherwise we'll update it when we're ready to merge it.

@brawaru brawaru force-pushed the feat/add-chat-type-events branch from 0cd4898 to c162217 Compare August 17, 2022 08:52
@brawaru
Copy link
Copy Markdown
Contributor Author

brawaru commented Aug 17, 2022

Heyo! I have rebased this on 2.x, partly re-implementing the changes instead of resolving confusing merge conflicts, so please review the code again, perhaps I missed something.

brawaru
brawaru commented Aug 17, 2022
View reviewed changes
Comment thread Essentials/src/main/java/net/essentialsx/api/v2/ChatType.java
@brawaru brawaru force-pushed the feat/add-chat-type-events branch 2 times, most recently from 8977e3f to 3c60995 Compare August 19, 2022 11:35
JRoy
JRoy requested changes Aug 19, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@JRoy JRoy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

final few things, otherwise approved for 2.20!

Comment thread Essentials/src/main/java/net/essentialsx/api/v2/events/chat/ChatEvent.java Outdated
Comment thread Essentials/src/main/java/net/essentialsx/api/v2/events/chat/LocalChatEvent.java
@brawaru
Add separate events for local and global chat
7bd890d 
This commit adds two new events: GlobalChatEvent and LocalChatEvent,
which allow other plugin developers to know whether the message sent is
a global or local one and act accordingly. If either of those events is
cancelled, then the source event is cancelled too.

Since all chat-related events share the same structure, a new abstract
class ChatEvent is created with change made for LocalChatSpyEvent to use
it without breaking its API.
@brawaru brawaru force-pushed the feat/add-chat-type-events branch from 3c60995 to 7bd890d Compare August 20, 2022 08:57
@mdcfe mdcfe enabled auto-merge (squash) February 13, 2023 23:12
@mdcfe mdcfe disabled auto-merge February 13, 2023 23:12
@mdcfe mdcfe enabled auto-merge (squash) February 13, 2023 23:12
@mdcfe mdcfe merged commit 17051ea into EssentialsX:2.x Feb 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mdcfe mdcfe mdcfe approved these changes

@JRoy JRoy JRoy approved these changes

Assignees

No one assigned

Labels

module: chat Issues or PRs for the EssentialsChat module type: api Issue/Pull Request regards user-facing API

Projects

None yet

Milestone

2.20.0

Development

Successfully merging this pull request may close these issues.

4 participants

@brawaru @mdcfe @JRoy @triagonal