Adds a TalismanActivatedEvent which fires when a Player uses a Talisman. #3920

Sniperkaos · 2023-07-25T22:07:05Z

Description

I found it odd that there wasn't an event to listen for when Talismans are activated, and thought it would be
helpful for one to be added.

Proposed changes

Added TalismanActivationEvent, which extends PlayerEvent.
It is fired when the static function activateTalisman is called.

Checklist

I have fully tested the proposed changes and promise that they will not break everything into chaos.
I have also tested the proposed changes in combination with various popular addons and can confirm my changes do not break them.
I have made sure that the proposed changes do not break compatibility across the supported Minecraft versions (1.16.* - 1.20.*).
I followed the existing code standards and didn't mess up the formatting.
I did my best to add documentation to any public classes or methods I added.
I have added Nonnull and Nullable annotations to my methods to indicate their behaviour for null values
I added sufficient Unit Tests to cover my code.

Activates when a Talisman is activated.

woops

github-actions · 2023-07-25T22:07:19Z

Pro Tip!
You can help us label your Pull Requests by using the following branch naming convention next time you create a pull request. ❤️

Branch naming convention	Label
`feature/**`	🎈 Feature
`fix/**`	✨ Fix
`chore/**`	🧹 Chores
`api/**`	🔧 API
`performance/**`	💡 Performance Optimization
`compatibility/**`	🤝 Compatibility

If your changes do not fall into any of these categories, don't worry. You can just ignore this message in that case! 👀

github-actions · 2023-07-25T22:15:48Z

Slimefun preview build

A Slimefun preview build is available for testing!
Commit: 68fa4e85

https://preview-builds.walshy.dev/download/Slimefun/3920/68fa4e85

Note: This is not a supported build and is only here for the purposes of testing.
Do not run this on a live server and do not report bugs anywhere but this PR!

TheBusyBiscuit

Nice idea but some changes need to be made :)

src/main/java/io/github/thebusybiscuit/slimefun4/api/events/TalismanActivatedEvent.java

...java/io/github/thebusybiscuit/slimefun4/implementation/items/magical/talismans/Talisman.java

src/main/java/io/github/thebusybiscuit/slimefun4/api/events/TalismanActivatedEvent.java

...java/io/github/thebusybiscuit/slimefun4/implementation/items/magical/talismans/Talisman.java

…lismanActivatedEvent.java changes variable names to camel case Co-authored-by: TheBusyBiscuit <[email protected]>

…lismanActivatedEvent.java changes the who variable to a more clear player variable Co-authored-by: Sefiraat <[email protected]>

Conflicts: src/main/java/io/github/thebusybiscuit/slimefun4/api/events/TalismanActivatedEvent.java

J3fftw1 · 2023-07-26T15:13:38Z

...java/io/github/thebusybiscuit/slimefun4/implementation/items/magical/talismans/Talisman.java

-            talisman.sendMessage(p);
+        TalismanActivatedEvent TalismanEvent = new TalismanActivatedEvent(p, talisman, talismanItem);
+        Bukkit.getPluginManager().callEvent(TalismanEvent);
+        if(!TalismanEvent.isCancelled()) {


Suggested change

if(!TalismanEvent.isCancelled()) {

if (!TalismanEvent.isCancelled()) {

I'm pretty sure I committed this but apparently the change hasn't gone through, I don't really know why

...java/io/github/thebusybiscuit/slimefun4/implementation/items/magical/talismans/Talisman.java

…n/items/magical/talismans/Talisman.java adds a space for readability Co-authored-by: J3fftw <[email protected]>

…n/items/magical/talismans/Talisman.java more spaces for readability Co-authored-by: J3fftw <[email protected]>

…n/items/magical/talismans/Talisman.java didnt commit the first time I guess Co-authored-by: J3fftw <[email protected]>

J3fftw1 · 2023-07-26T19:09:07Z

src/main/java/io/github/thebusybiscuit/slimefun4/api/events/TalismanActivatedEvent.java

+ *
+ */
+
+public class TalismanActivatedEvent extends PlayerEvent implements Cancellable {


We might wanna rename this.
when it’s cancelled it’s not activated.
So maybe TalismanActivatEvent Or something else

That's a good idea. I didn't even think of that.

Phoenix-Starlight · 2023-07-27T15:39:26Z

Due to me writing by mail, you need to lowercase the variable name 'Handlers'

…

On 7/26/23, China Worldstar ***@***.***> wrote: @Sniperkaos commented on this pull request. > +import org.bukkit.event.Cancellable; +import org.bukkit.event.HandlerList; +import org.bukkit.event.player.PlayerEvent; +import org.bukkit.inventory.ItemStack; + +import io.github.thebusybiscuit.slimefun4.implementation.items.magical.talismans.Talisman; + +/** + * + * This ***@***.*** PlayerEvent} is called when a ***@***.*** Player} activates a ***@***.*** Talisman} + * + * @author cworldstar + * + */ + +public class TalismanActivatedEvent extends PlayerEvent implements Cancellable { That's a good idea. I didn't even think of that. -- Reply to this email directly or view it on GitHub: #3920 (comment) You are receiving this because you are subscribed to this thread. Message ID: ***@***.***>

iTwins · 2023-08-03T00:41:36Z

src/main/java/io/github/thebusybiscuit/slimefun4/api/events/TalismanActivatedEvent.java

+	 * @return The {@link Talisman} used.
+	 *
+	 */
+	@Nonnull


According to the style preferences, annotations that target the return type should be inline. Same for line 60.

Suggested change

@Nonnull

public @Nonnull Talisman getTalisman() {

Sefiraat · 2023-09-03T10:08:51Z

@Sniperkaos Still working on the suggestions above or happy for it to be closed?

Co-authored-by: TheBusyBiscuit <[email protected]> Co-authored-by: Sefiraat <[email protected]> Co-authored-by: J3fftw <[email protected]> Co-authored-by: Daniel Walsh <[email protected]> Co-authored-by: China Worldstar <[email protected]> Co-authored-by: cworldstar <[email protected]> Co-authored-by: Alessio Colombo <[email protected]>

Sniperkaos and others added 4 commits July 25, 2023 10:16

Update Talisman.java

bdbb9ad

Adds TalismanActivatedEvent to Slimefun.

0bb8cb9

Activates when a Talisman is activated.

implements cancellable

f7b7566

Update TalismanActivatedEvent.java

c449de2

woops

Sniperkaos requested a review from a team as a code owner July 25, 2023 22:07

TheBusyBiscuit added the 🔧 API This Pull Request introduces API changes. label Jul 25, 2023

TheBusyBiscuit requested changes Jul 25, 2023

View reviewed changes

TheBusyBiscuit self-assigned this Jul 25, 2023

Sefiraat reviewed Jul 26, 2023

View reviewed changes

src/main/java/io/github/thebusybiscuit/slimefun4/api/events/TalismanActivatedEvent.java Outdated Show resolved Hide resolved

Sefiraat reviewed Jul 26, 2023

View reviewed changes

...java/io/github/thebusybiscuit/slimefun4/implementation/items/magical/talismans/Talisman.java Outdated Show resolved Hide resolved

cworldstar and others added 4 commits July 26, 2023 08:22

added cancelling logic & changed variable names to camel case

3520e21

forgot to remove some TODO stubs

9612538

Update src/main/java/io/github/thebusybiscuit/slimefun4/api/events/Ta…

4144075

…lismanActivatedEvent.java changes variable names to camel case Co-authored-by: TheBusyBiscuit <[email protected]>

Update src/main/java/io/github/thebusybiscuit/slimefun4/api/events/Ta…

de78695

…lismanActivatedEvent.java changes the who variable to a more clear player variable Co-authored-by: Sefiraat <[email protected]>

Sniperkaos marked this pull request as draft July 26, 2023 12:33

Merge branch 'master' of https://github.com/Sniperkaos/TalismanEvent.git

1b2c9e0

Conflicts: src/main/java/io/github/thebusybiscuit/slimefun4/api/events/TalismanActivatedEvent.java

J3fftw1 suggested changes Jul 26, 2023

View reviewed changes

Sniperkaos and others added 2 commits July 26, 2023 14:12

Update src/main/java/io/github/thebusybiscuit/slimefun4/implementatio…

2d248e5

…n/items/magical/talismans/Talisman.java adds a space for readability Co-authored-by: J3fftw <[email protected]>

Update src/main/java/io/github/thebusybiscuit/slimefun4/implementatio…

ffb8899

…n/items/magical/talismans/Talisman.java more spaces for readability Co-authored-by: J3fftw <[email protected]>

Sniperkaos marked this pull request as ready for review July 26, 2023 18:13

Sniperkaos requested review from TheBusyBiscuit and J3fftw1 July 26, 2023 18:13

Update src/main/java/io/github/thebusybiscuit/slimefun4/implementatio…

3c6803e

…n/items/magical/talismans/Talisman.java didnt commit the first time I guess Co-authored-by: J3fftw <[email protected]>

J3fftw1 suggested changes Jul 26, 2023

View reviewed changes

iTwins reviewed Aug 3, 2023

View reviewed changes

JustAHuman-xD mentioned this pull request Dec 7, 2023

Add TalismanActivateEvent (Updated version of #3920) #4045

Merged

7 tasks

TheBusyBot added the ⚡ Merge Conflicts This Pull Request has merged conflicts which need to be resolved! label Dec 12, 2023

Sfiguz7 closed this Dec 12, 2023

Sfiguz7 added Stale Marks a PR as stale. and removed ⚡ Merge Conflicts This Pull Request has merged conflicts which need to be resolved! 🔧 API This Pull Request introduces API changes. labels Dec 12, 2023

Sfiguz7 mentioned this pull request Dec 12, 2023

Actually check if the negative tests do their job #4054

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds a TalismanActivatedEvent which fires when a Player uses a Talisman. #3920

Adds a TalismanActivatedEvent which fires when a Player uses a Talisman. #3920

Sniperkaos commented Jul 25, 2023 •

edited

Loading

github-actions bot commented Jul 25, 2023

github-actions bot commented Jul 25, 2023 •

edited

Loading

TheBusyBiscuit left a comment

J3fftw1 Jul 26, 2023

Sniperkaos Jul 26, 2023

J3fftw1 Jul 26, 2023

Sniperkaos Jul 26, 2023

Phoenix-Starlight commented Jul 27, 2023 via email

iTwins Aug 3, 2023

Sefiraat commented Sep 3, 2023

	if(!TalismanEvent.isCancelled()) {
	if (!TalismanEvent.isCancelled()) {

Adds a TalismanActivatedEvent which fires when a Player uses a Talisman. #3920

Adds a TalismanActivatedEvent which fires when a Player uses a Talisman. #3920

Conversation

Sniperkaos commented Jul 25, 2023 • edited Loading

Description

Proposed changes

Checklist

github-actions bot commented Jul 25, 2023

github-actions bot commented Jul 25, 2023 • edited Loading

Slimefun preview build

TheBusyBiscuit left a comment

Choose a reason for hiding this comment

J3fftw1 Jul 26, 2023

Choose a reason for hiding this comment

Sniperkaos Jul 26, 2023

Choose a reason for hiding this comment

J3fftw1 Jul 26, 2023

Choose a reason for hiding this comment

Sniperkaos Jul 26, 2023

Choose a reason for hiding this comment

Phoenix-Starlight commented Jul 27, 2023 via email

iTwins Aug 3, 2023

Choose a reason for hiding this comment

Sefiraat commented Sep 3, 2023

Sniperkaos commented Jul 25, 2023 •

edited

Loading

github-actions bot commented Jul 25, 2023 •

edited

Loading