Pre Player Attack Entity #8329

MrScopes · 2025-12-23T08:26:55Z

Problem

This event could be useful in some situations.
https://jd.papermc.io/paper/1.21.11/io/papermc/paper/event/player/PrePlayerAttackEntityEvent.html

Solution

Added [player] pre attack[ing] [an] [entity]
Added [the] (entity|victim) (:will|will not|won't) be attack(ed|ing)

Testing Completed

on player pre attack entity:
    if victim will be attacked:
        send "attack on %entity% was canceled"
        cancel event
    else:
        # tested with 'listen to cancelled events by default: true'
        send "%victim% will not be attacked"
    send "event is cancelled" if event is cancelled else "event is not cancelled"

Supporting Information

Examples and descriptions need some work.
Honestly the will/won't be attacked can probably be removed. It's really not too useful from what I can tell and the event already won't be called unless you enable the config setting to listen to canceled events, since it's sent as canceled already if the entity is non-living and won't be attacked.
For the condition, I went with (entity|victim) instead of an expression since the event itself just has willAttack(boolean). only concern is I'm not sure if this will cause any conflicts. Whole thing needs some work but it's a start

Since it's a player event, I set the event value for command sender to be the player in the event
event-entity is also set to the getAttacked() of the event
also edited ExprAttacked/victim expression to support this so the event could use

on player pre attack entity:
    kill victim
    # or
    kill entity

Completes: 8266
Related: none
AI assistance: none

sovdeeth · 2025-12-23T08:37:01Z

Note that listening to cancelled events does not require the config, you can simply do on cancelled X or on any X

MrScopes · 2025-12-23T08:38:42Z

Just a thought, could maybe still take an expression but not do anything with it for the condition, or maybe [event-](entity|victim) etc. But obviously could lead to some confusion

MrScopes · 2025-12-23T08:40:56Z

Note that listening to cancelled events does not require the config, you can simply do on cancelled X or on any X

Good to know. I can update the examples and description with that + whatever else is decided

sovdeeth · 2025-12-24T07:40:22Z

src/main/java/ch/njol/skript/conditions/CondWillBeAttacked.java

+@Name("Will Be Attacked")
+@Description("""
+	Checks if the entity in <a href='#Evt'>Player Pre Attack Entity Event</a> will be attacked.
+	Returns false for non-living entities. However, the event won't be called for them unless explicitly listened to.


should clarify what "explicitly listened to" means

sovdeeth · 2025-12-24T07:43:22Z

src/main/java/ch/njol/skript/conditions/CondWillBeAttacked.java

+
+	static {
+		Skript.registerCondition(CondWillBeAttacked.class,
+				"[the] [event-](entity|victim) (:will|will not|won't) be attacked"


i do not like using event-entity and victim literally in syntaxes, since readers of code will assume they are expressions like they normally are.
If this is always equal to isCancelled, as the javadocs imply, I would say you can just remove the condition entirely.

sovdeeth · 2025-12-24T07:43:41Z

src/main/java/ch/njol/skript/conditions/CondWillBeAttacked.java

+	public boolean check(Event e) {
+		return (e instanceof PrePlayerAttackEntityEvent && ((PrePlayerAttackEntityEvent) e).willAttack()) ^ isNegated();
+	}
+
+	@Override
+	public String toString(@Nullable Event e, boolean debug) {


use event, not e

sovdeeth · 2025-12-24T07:44:22Z

src/main/java/ch/njol/skript/conditions/CondWillBeAttacked.java

+
+	@Override
+	public boolean check(Event e) {
+		return (e instanceof PrePlayerAttackEntityEvent && ((PrePlayerAttackEntityEvent) e).willAttack()) ^ isNegated();


use pattern variable here

sovdeeth · 2025-12-24T07:45:25Z

src/main/java/ch/njol/skript/events/SimpleEvents.java

 			.since("2.12");

+		Skript.registerEvent("Pre Player Attack Entity Event", SimpleEvent.class, PrePlayerAttackEntityEvent.class,
+				"[player] pre attack[ing] [an] [entity]")


can you come up with a better syntax than pre attacking? it's really clunky as is but I don't know if I have better suggestions
maybe something along the lines of before attack?

sovdeeth · 2025-12-24T07:48:02Z

src/main/java/ch/njol/skript/events/SimpleEvents.java

+			.examples("""
+				on player pre attack entity:
+					cancel event
+					send "Your attack was canceled!"


this would (should) cause a parse error
You will need to update the event value for event-entity to add the pre-attack event as a case to use attacker/victim.
Also need to update ExprAttacker to support attacker in the pre attack event.

this would (should) cause a parse error You will need to update the event value for event-entity to add the pre-attack event as a case to use attacker/victim. Also need to update ExprAttacker to support attacker in the pre attack event.

the reason I didn't make it attacker is since it's always going to be a player event, but yeah making it attacker would be easy. will do tomorrow. command sender is set to player in the event so it won't have any errors in my example

yeah the issue is that what if a player attacks another player? now there's 2 event-players and it's ambiguous which one the user meant

sovdeeth · 2025-12-24T07:48:52Z

src/main/java/ch/njol/skript/expressions/ExprAttacked.java

+		else if (e instanceof PrePlayerAttackEntityEvent)
+			entity = ((PrePlayerAttackEntityEvent) e).getAttacked();


please update the expression to use event instead of e and to use pattern variables while you're here.
and the {} for if else
and any other violations of our coding conventions exist in this class

sovdeeth · 2025-12-24T07:50:04Z

src/main/java/ch/njol/skript/classes/data/BukkitEventValues.java

+		EventValues.registerEventValue(PrePlayerAttackEntityEvent.class, Entity.class, PrePlayerAttackEntityEvent::getAttacked);
+		EventValues.registerEventValue(PrePlayerAttackEntityEvent.class, CommandSender.class, PrePlayerAttackEntityEvent::getPlayer);


neither of these are necessary, since the user should be using attacker and victim

Efnilite

looks good after sovde's changes

Efnilite · 2025-12-25T20:33:03Z

src/main/java/ch/njol/skript/conditions/CondWillBeAttacked.java

+
+@Name("Will Be Attacked")
+@Description("""
+	Checks if the entity in <a href='#Evt'>Player Pre Attack Entity Event</a> will be attacked.


Suggested change

Checks if the entity in <a href='#Evt'>Player Pre Attack Entity Event</a> will be attacked.

Checks if the entity in <a href='#PlayerPreAttackEntity'>Player Pre Attack Entity Event</a> will be attacked.

Efnilite · 2025-12-25T20:33:48Z

src/main/java/ch/njol/skript/events/SimpleEvents.java

+				"[player] pre attack[ing] [an] [entity]")
+			.description(
+				"Called when a player tries to attack an entity.",
+				"Canceling this event will prevent the attack and any sounds being played when attacking.",


Suggested change

"Canceling this event will prevent the attack and any sounds being played when attacking.",

"Canceling this event will prevent the attack and any sounds from being played when attacking.",

Pre Player Attack Entity

69d50e7

MrScopes requested a review from a team as a code owner December 23, 2025 08:26

MrScopes requested review from Pesekjak and TheMug06 and removed request for a team December 23, 2025 08:26

skriptlang-automation bot added the needs reviews A PR that needs additional reviews label Dec 23, 2025

MrScopes added 3 commits December 23, 2025 15:53

optional 'event-' prefix to entity/victim in CondWillBeAttacked

d049dd2

better descriptions

c12db82

update description and syntax

847986b

sovdeeth added the feature Pull request adding a new feature. label Dec 24, 2025

sovdeeth requested changes Dec 24, 2025

View reviewed changes

Efnilite requested changes Dec 25, 2025

View reviewed changes

skriptlang-automation bot added needs reviews A PR that needs additional reviews and removed needs reviews A PR that needs additional reviews labels Dec 25, 2025

		else if (e instanceof PrePlayerAttackEntityEvent)
		entity = ((PrePlayerAttackEntityEvent) e).getAttacked();

		EventValues.registerEventValue(PrePlayerAttackEntityEvent.class, Entity.class, PrePlayerAttackEntityEvent::getAttacked);
		EventValues.registerEventValue(PrePlayerAttackEntityEvent.class, CommandSender.class, PrePlayerAttackEntityEvent::getPlayer);

	Checks if the entity in <a href='#Evt'>Player Pre Attack Entity Event</a> will be attacked.
	Checks if the entity in <a href='#PlayerPreAttackEntity'>Player Pre Attack Entity Event</a> will be attacked.

	"Canceling this event will prevent the attack and any sounds being played when attacking.",
	"Canceling this event will prevent the attack and any sounds from being played when attacking.",

Uh oh!

Pre Player Attack Entity #8329

Are you sure you want to change the base?

Pre Player Attack Entity #8329

Conversation

MrScopes commented Dec 23, 2025

Problem

Solution

Testing Completed

Supporting Information

Uh oh!

sovdeeth commented Dec 23, 2025

Uh oh!

MrScopes commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MrScopes commented Dec 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Efnilite left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MrScopes commented Dec 23, 2025 •

edited

Loading