Initial implementation of Entity Interaction Events #183

Quplet · 2022-08-22T19:54:19Z

Adds an interaction module containing (as of now) the basic Player interaction events similar to Fabric's implementation, and a LivingEntityAttack event.

TODO:

Separate cancellable callbacks into BEFORE and AFTER events
- LivingEntityAttackEvents
- AttackBlockEvents (Player)
- AttackEntityEvents (Player)
- UseBlockEvents (Player)
- UseEntityEvents (Player)
- UseItemEvents (Player)
Add more LivingEntity events (like EnderManPickUpBlock event)

0xJoeMama

Some generic nitpicks and ideas.

...ty/interaction/src/main/java/org/quiltmc/qsl/entity/interaction/mixin/LivingEntityMixin.java

.../main/java/org/quiltmc/qsl/entity/interaction/mixin/ServerPlayerInteractionManagerMixin.java

...interaction/src/main/java/org/quiltmc/qsl/entity/interaction/api/player/UseItemCallback.java

TheGlitch76 · 2022-08-28T15:57:15Z

...raction/src/main/java/org/quiltmc/qsl/entity/interaction/api/player/AttackBlockCallback.java

+ * 	   <li>{@link ActionResult#FAIL} cancels further processing and does not send a packet to the server.</li>
+ * </ul>
+ */
+public interface AttackBlockCallback {


I know this is based on the QM name, but I don't like calling it "attacking" a block, because it's really the beginning of a player breaking (destroying) a block.

Would this maybe make more sense if it was part of BreakBlockEvents?

I think they have different purposes... its kinda hard to describe. The action of left clicking vs the event of breaking.
Break block events to me are designed to be acted upon the block's breaking more than the player's action while this is more the player's action than the block breaking, if that makes any sense.

I'm fine with moving it over tho if people agree it fits better with the block breaking events.

...nteraction/src/main/java/org/quiltmc/qsl/entity/interaction/api/player/BreakBlockEvents.java

Platymemo

I like this! Just some nitpicks.

Also, an alternative for the DamageContext is to have a separate MODIFY_DAMAGE event that fires if the before event is not canceled. That way all the events are cohesive.

Platymemo · 2022-09-15T23:25:00Z

...y/entity/interaction/src/main/java/org/quiltmc/qsl/entity/interaction/api/DamageContext.java

+ * An encapsulation of several arguments relevant to a damage context with a
+ *     mutable damage value and cancellation that is shared across all listeners.
+ */
+public class DamageContext {


Annotating members with @Nullable and @NotNull would be really helpful!

Imo, nothing in it should ever be null. Should I just annotate everything with @notNull?

Platymemo · 2022-09-15T23:32:55Z

...teraction/src/main/java/org/quiltmc/qsl/entity/interaction/api/LivingEntityAttackEvents.java

+		 * @param source the {@link DamageSource} of the attack
+		 * @param damage the damage that was dealt
+		 */
+		void afterDamage(LivingEntity attacker, ItemStack stack, LivingEntity target, DamageSource source, float damage);


I wonder if there should be two DamageContexts. A MutableDamageContext for the before event, and an ImmutableDamageContext (names very much up for debate) for the after event. Then these interfaces can even be merged into one.

So two more classes extending a abstract DamageContext? I think that can work.

The separation of the Before and After functional interfaces I believe are more for clarification purposes however. The documentation could become a bit confusing if they are merged.

Coming back to this, I think a separate MODIFY_DAMAGE event would be better. That way you have the ability to cancel it, modify it, or react to it in clear, separate events.

I believe this would create a lot of duplicate code on the user's part. I think logic that determines cancellation or modifying damage would align a lot of the time and I'd rather not force users to duplicate code to perform these tasks.

...raction/src/main/java/org/quiltmc/qsl/entity/interaction/api/player/AttackBlockCallback.java

Platymemo · 2022-09-15T23:34:49Z

...raction/src/main/java/org/quiltmc/qsl/entity/interaction/api/player/AttackBlockCallback.java

+ * <p>
+ * Is hooked before the spectator check, so make sure to check the player's game mode!
+ * <ul>
+ *     <li>{@link ActionResult#SUCCESS} cancels further processing and, on the client, sends a packet to the server.</li>


linking the class of the packet would be useful! (also in all the other places that have similar docs)

Easy enough to do, but I'm not so sure why that would be helpful. All the packet really does is tell the logical server to process the event on their side.

Just lets devs jump around the codebase a little easier, in case they want to look at how the interaction is processed

.../interaction/src/main/java/org/quiltmc/qsl/entity/interaction/api/player/UseBlockEvents.java

...interaction/src/main/java/org/quiltmc/qsl/entity/interaction/api/player/UseEntityEvents.java

.../interaction/src/main/java/org/quiltmc/qsl/entity/interaction/api/player/UseBlockEvents.java

...interaction/src/main/java/org/quiltmc/qsl/entity/interaction/api/player/UseEntityEvents.java

...y/interaction/src/main/java/org/quiltmc/qsl/entity/interaction/api/player/UseItemEvents.java

Platymemo · 2022-10-27T22:58:34Z

...ty/interaction/src/main/java/org/quiltmc/qsl/entity/interaction/mixin/LivingEntityMixin.java

+		return damage;
+	}
+
+	@Inject(method = "damage", at = @At(value = "HEAD", shift = At.Shift.AFTER), cancellable = true)


I'd say give this method priority so other @Injects at HEAD get run after this and it can cancel before other mods do funky things.

Platymemo · 2022-10-27T22:59:04Z

...teraction/src/main/java/org/quiltmc/qsl/entity/interaction/api/LivingEntityAttackEvents.java

+		 * @param source the {@link DamageSource} of the attack
+		 * @param damage the damage that was dealt
+		 */
+		void afterDamage(LivingEntity attacker, ItemStack stack, LivingEntity target, DamageSource source, float damage);


Coming back to this, I think a separate MODIFY_DAMAGE event would be better. That way you have the ability to cancel it, modify it, or react to it in clear, separate events.

Quplet and others added 7 commits August 17, 2022 23:31

AttackEntityCallback and LivingEntityAttackCallback

5f89cdb

testmod

f049b20

added player use interactions

4673b65

Merge branch 'QuiltMC:1.19' into 1.19

2afbca2

AttackBlockCallback and PlayerBreakBlockEvents

08f1a12

javadocs

f172a97

Merge branch 'QuiltMC:1.19' into 1.19

3eccaf4

Quplet requested a review from a team August 22, 2022 19:54

LambdAurora changed the title ~~Initial implimentation of Enitity Interaction Events~~ Initial implimentation of Entity Interaction Events Aug 22, 2022

LambdAurora changed the title ~~Initial implimentation of Entity Interaction Events~~ Initial implementation of Entity Interaction Events Aug 22, 2022

Quplet added 3 commits August 22, 2022 21:19

cleaned up javadocs

37f755f

Merge remote-tracking branch 'origin/1.19' into 1.19

2284a90

Corrected licenses

9168151

0xJoeMama reviewed Aug 24, 2022

View reviewed changes

Quplet and others added 6 commits August 25, 2022 09:53

added ItemStack to relevant events

a4d1824

improved attack and use events

fa5dbf1

forgot a javadoc

68c5fff

moved DamageContext from impl to api

8f45bff

split UseItemCallback into two events

1264907

Merge branch 'QuiltMC:1.19' into 1.19

fa68216

TheGlitch76 reviewed Aug 28, 2022

View reviewed changes

TheGlitch76 removed documentation enhancement New feature or request labels Aug 28, 2022

EnnuiL marked this pull request as draft August 30, 2022 01:21

Quplet and others added 3 commits August 30, 2022 17:45

split AttackEntityCallback, UseBlockCallback, and UseEntityCallback

8e0b114

Merge branch 'QuiltMC:1.19' into 1.19

7ba2570

Merge remote-tracking branch 'origin/1.19' into 1.19

8b23b17

Platymemo approved these changes Sep 15, 2022

View reviewed changes

Updated documentation

98e4734

Platymemo suggested changes Oct 27, 2022

View reviewed changes

Merge branch 'QuiltMC:1.19' into 1.19

9a57c84

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial implementation of Entity Interaction Events #183

Initial implementation of Entity Interaction Events #183

Quplet commented Aug 22, 2022 •

edited

Loading

0xJoeMama left a comment

TheGlitch76 Aug 28, 2022

Quplet Aug 29, 2022

Platymemo left a comment

Platymemo Sep 15, 2022

Quplet Sep 24, 2022

Platymemo Sep 15, 2022

Quplet Sep 24, 2022

Quplet Sep 24, 2022

Platymemo Oct 27, 2022

Quplet Oct 31, 2022

Platymemo Sep 15, 2022

Quplet Sep 24, 2022

Platymemo Oct 27, 2022

Platymemo Oct 27, 2022

Platymemo Oct 27, 2022

Initial implementation of Entity Interaction Events #183

Are you sure you want to change the base?

Initial implementation of Entity Interaction Events #183

Conversation

Quplet commented Aug 22, 2022 • edited Loading

0xJoeMama left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Platymemo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Quplet commented Aug 22, 2022 •

edited

Loading