Add worldborders #7006

Phill310 · 2024-08-29T15:59:21Z

Description

Add worldborder syntax to Skript. Continuation of #5229
Player's worldborder is always virtual

Conditions:

updated IsWithin condition

Effects:

expand/shrink worldborder (maybe add grow/contract aliases)
I don't like the way I am registering the syntax right now with the of and 's but I can't think of a different way

Events:

Worldborder bounds change
Worldborder bounds finish change
Worldborder center change

Expressions:

Sections:

Create worldborder

Target Minecraft Versions: any
Requirements: Paper for worldborder events
Related Issues: #5178, #3848

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

src/main/java/ch/njol/skript/effects/EffWorldBorderExpand.java

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

Fusezion

TEST!

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

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

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

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

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

Fusezion · 2024-08-29T16:32:46Z

A lot of chez's stuff might of been repeated he beat me ;(

src/test/skript/tests/syntaxes/effects/EffWorldborderExpand.sk

sovdeeth

just needs some formatting updates, mainly around annotations!

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

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

src/main/java/ch/njol/skript/effects/EffWorldBorderExpand.java

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

src/main/java/ch/njol/skript/bukkitutil/BukkitUnsafe.java

src/main/java/ch/njol/skript/aliases/Aliases.java

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

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

src/main/java/ch/njol/skript/effects/EffWorldBorderExpand.java

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

Efnilite · 2024-12-25T20:22:51Z

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

+import org.jetbrains.annotations.Nullable;
+
+@Name("Warning Time of World Border")
+@Description("The warning time of a world border. If the border is shrinking, the player's screen will be tinted red once the border will catch the player within this time period.")


so if the player is outside the border it will be tinted red after one second? im not sure what this expression does

Its specifically when the worldborder is shrinking. If the player is outside the final worldborder (after the shrink), their screen will turn red x seconds before it reaches their current location

src/test/skript/tests/syntaxes/effects/EffWorldborderExpand.sk

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

src/test/skript/tests/syntaxes/effects/EffWorldborderExpand.sk

Absolutionism

Just a few things

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

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

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

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

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

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

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

Absolutionism · 2024-12-25T20:44:19Z

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

+		Location location = mode == ChangeMode.SET ? (Location) delta[0] : null;
+		for (WorldBorder worldBorder : getExpr().getArray(event)) {
+			switch (mode) {
+				case SET:


Not a big deal, but maybe an enhanced switch?

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

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

…order#getMaxCenterCoordinate

Co-authored-by: sovdee <10354869+sovdeeth@users.noreply.github.com>

Fusezion

Leaving a proper review to other people, but uhh thoughts on WorldBorder x AnySizedThing? size of worldborder, set size of worldborder to 10

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

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

Absolutionism

Looking good

Absolutionism · 2025-03-07T06:20:08Z

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

@@ -53,6 +53,7 @@
 import org.bukkit.event.player.PlayerQuitEvent.QuitReason;
 import org.bukkit.event.player.PlayerResourcePackStatusEvent.Status;
 import org.bukkit.event.player.PlayerTeleportEvent.TeleportCause;
+import org.bukkit.event.player.PlayerExpCooldownChangeEvent.ChangeReason;


I know you've had some trouble merging/updating your branch, so let's hope nothing got removed in the making.

src/main/java/ch/njol/skript/effects/EffWorldBorderExpand.java

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

Absolutionism · 2025-03-07T06:32:50Z

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

+					if (((long) worldBorder.getWarningDistance() + input) > Integer.MAX_VALUE) {
+						worldBorder.setWarningDistance(Integer.MAX_VALUE);
+					} else if (((long) worldBorder.getWarningDistance() + input) < Integer.MIN_VALUE) {
+						worldBorder.setWarningDistance(Integer.MIN_VALUE);
+					} else {
+						worldBorder.setWarningDistance(Math.max(worldBorder.getWarningDistance() + input, 0));
+					}
+					break;


Suggested change

if (((long) worldBorder.getWarningDistance() + input) > Integer.MAX_VALUE) {

worldBorder.setWarningDistance(Integer.MAX_VALUE);

} else if (((long) worldBorder.getWarningDistance() + input) < Integer.MIN_VALUE) {

worldBorder.setWarningDistance(Integer.MIN_VALUE);

} else {

worldBorder.setWarningDistance(Math.max(worldBorder.getWarningDistance() + input, 0));

}

break;

int current = worldBorder.getWarningDistance();

int value = Math2.fit(0, current + input, Integer.MAX_VALUE);

worldBorder.setWarningDistance(value)

Shouldnt be using MIN_VALUE because that's a negative, I dont think a world border should have a negative distance.

The MIN_VALUE part is true but I did the rest of it to catch integer overflows during the addition / subtraction. It seems like the Math2.fit wouldn't help that unless I am misunderstanding the code

Well one thing you should do, is in #acceptChange instead of returning Number.class you should do Integer.class in my opinion. As that in itself would exclude any nan and infinite values. As well as capping the provided number to Integer.MAX_VALUE

I dont think switching it to integer class fixed the integer overflow issues so I think it might leave it as is with the MIN_VALUE thing fixed

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

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

src/test/skript/tests/syntaxes/sections/ExprSecCreateWorldBorder.sk

Co-authored-by: SirSmurfy2 <82696841+TheAbsolutionism@users.noreply.github.com>

Phill310 · 2025-03-08T03:12:27Z

Leaving a proper review to other people, but uhh thoughts on WorldBorder x AnySizedThing? size of worldborder, set size of worldborder to 10

What do you mean? Is this some newer feature that I haven't seen yet / forgot about?

Absolutionism

Looks good to me

sovdeeth

looks good to me
i appreciate the very thorough tests

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

cheeezburga reviewed Aug 29, 2024

View reviewed changes

Fusezion suggested changes Aug 29, 2024

View reviewed changes

sovdeeth added the feature Pull request adding a new feature. label Aug 30, 2024

Phill310 marked this pull request as ready for review September 9, 2024 01:55

Moderocky requested changes Sep 13, 2024

View reviewed changes

src/test/skript/tests/syntaxes/effects/EffWorldborderExpand.sk Outdated Show resolved Hide resolved

sovdeeth requested changes Sep 13, 2024

View reviewed changes

Moderocky force-pushed the feature/worldborder branch from 2cdbc4e to d7dbc0c Compare December 25, 2024 20:15

Efnilite requested changes Dec 25, 2024

View reviewed changes

Absolutionism requested changes Dec 25, 2024

View reviewed changes

Moderocky force-pushed the feature/worldborder branch from 499ff66 to e6eef8b Compare December 26, 2024 18:17

Phill310 and others added 19 commits December 26, 2024 18:20

Initial setup

65e0efc

Fix imports

a3f7f47

Use pattern variables for instanceof

000e562

Cleaner switch statements

28044ac

Specify paper version

dd4f4f4

Use newer timespan method

593401d

Require "world border" when editing a world border's attributes

97c3ffc

Move IsInsideWorldBorder to IsWithin condition

1588c3d

Make variable name readable

8cb9c9d

Clean up conditions

e08a74b

Make radius/diameter optional

5c125f5

Make damage have a minimum of 0

47c2805

Make warning distance have a minimum of 0

3ccc84c

Make damage buffer have a minimum of 0

1b793ca

Make warning time have a minimum of 0

f759e46

Force the center location to stay inside the limits defined by WorldB…

dfc45fc

…order#getMaxCenterCoordinate

Tests!

3134439

End files with a new line

85a81e5

Apply suggestions from code review

4636119

Co-authored-by: sovdee <10354869+sovdeeth@users.noreply.github.com>

Phill310 requested review from sovdeeth, Absolutionism and Fusezion March 7, 2025 06:18

Fusezion suggested changes Mar 7, 2025

View reviewed changes

src/main/java/ch/njol/skript/classes/data/BukkitClasses.java Outdated Show resolved Hide resolved

src/main/java/ch/njol/skript/classes/data/BukkitEventValues.java Outdated Show resolved Hide resolved

Absolutionism requested changes Mar 7, 2025

View reviewed changes

Phill310 and others added 8 commits March 6, 2025 22:52

Apply suggestions from code review

e218d71

Co-authored-by: SirSmurfy2 <82696841+TheAbsolutionism@users.noreply.github.com>

Move clamp outside loop

b90b51c

Remove extra event-value registration

3cf5ddf

Improve example for World Border Bounds Change Event

a684e0e

Clean up imports

8fdae43

Set the Warning Distance to 0 rather than MIN_VALUE

c4e9400

Add more tests with large numbers

3741449

Account for integer overflow issues

99e2f78

Remove debug code

8a9d449

Phill310 requested review from Absolutionism and Fusezion March 8, 2025 03:21

Absolutionism approved these changes Mar 8, 2025

View reviewed changes

sovdeeth approved these changes Mar 15, 2025

View reviewed changes

src/main/java/ch/njol/skript/expressions/ExprWorldBorderCenter.java Outdated Show resolved Hide resolved

sovdeeth added the feature-ready A PR/issue that has been approved, tested and can be merged/closed in the next feature version. label Mar 15, 2025

Phill310 and others added 2 commits March 15, 2025 16:40

Use signum to clean up conditions

84300e6

Merge branch 'dev/feature' into feature/worldborder

52de464

Efnilite requested a review from a team as a code owner March 20, 2025 13:25

Efnilite requested review from cheeezburga and erenkarakal and removed request for Fusezion March 20, 2025 13:25

Merge branch 'dev/feature' into feature/worldborder

51051f0

Efnilite merged commit 1e43779 into SkriptLang:dev/feature Mar 20, 2025
5 checks passed

Phill310 deleted the feature/worldborder branch March 26, 2025 00:28

Absolutionism mentioned this pull request Jun 14, 2025

Implement worldborder support #5178

Closed

1 task

Uh oh!

Add worldborders #7006

Add worldborders #7006

Uh oh!

Conversation

Phill310 commented Aug 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Fusezion left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Fusezion commented Aug 29, 2024

Uh oh!

Uh oh!

sovdeeth left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Absolutionism left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Fusezion left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Absolutionism left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Phill310 commented Aug 29, 2024 •

edited

Loading