mirror of
https://github.com/PaperMC/Paper.git
synced 2024-11-01 00:10:32 +01:00
Improve GameRule API
This commit is contained in:
Jake Potrebic
parent
532dc51d5f
commit
fd896f0176
126
patches/api/0390-Improve-GameRule-API.patch
Normal file
126
patches/api/0390-Improve-GameRule-API.patch
Normal file
@ -0,0 +1,126 @@
|
|||||||
|
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
||||||
|
From: Jake Potrebic <jake.m.potrebic@gmail.com>
|
||||||
|
Date: Sat, 1 Jan 2022 15:54:09 -0800
|
||||||
|
Subject: [PATCH] Improve GameRule API
|
||||||
|
|
||||||
|
|
||||||
|
diff --git a/src/main/java/org/bukkit/Bukkit.java b/src/main/java/org/bukkit/Bukkit.java
|
||||||
|
index 92a1462261029e804da73da2743bbd68e57841e9..32fee5995a0279a3fa70d501aee458f2a1e10309 100644
|
||||||
|
--- a/src/main/java/org/bukkit/Bukkit.java
|
||||||
|
+++ b/src/main/java/org/bukkit/Bukkit.java
|
||||||
|
@@ -2397,6 +2397,19 @@ public final class Bukkit {
|
||||||
|
return server.isStopping();
|
||||||
|
}
|
||||||
|
|
||||||
|
+ /**
|
||||||
|
+ * Get the default value for a given {@link GameRule}. This value is not
|
||||||
|
+ * guaranteed to match the current value.
|
||||||
|
+ *
|
||||||
|
+ * @param rule the rule to return a default value for
|
||||||
|
+ * @param <T> the type of GameRule
|
||||||
|
+ * @return the default value
|
||||||
|
+ * @see GameRule#getDefaultValue()
|
||||||
|
+ */
|
||||||
|
+ public static <T> @NotNull T getGameRuleDefault(@NotNull GameRule<T> rule) {
|
||||||
|
+ return server.getGameRuleDefault(rule);
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
/**
|
||||||
|
* Returns the {@link com.destroystokyo.paper.entity.ai.MobGoals} manager
|
||||||
|
*
|
||||||
|
diff --git a/src/main/java/org/bukkit/GameRule.java b/src/main/java/org/bukkit/GameRule.java
|
||||||
|
index 38a1b02c006af766b0c10ee65e9fc28f5a922774..883cb5965eb8308c7c2785c683b24b4a5a0bbef7 100644
|
||||||
|
--- a/src/main/java/org/bukkit/GameRule.java
|
||||||
|
+++ b/src/main/java/org/bukkit/GameRule.java
|
||||||
|
@@ -290,6 +290,35 @@ public final class GameRule<T> implements net.kyori.adventure.translation.Transl
|
||||||
|
}
|
||||||
|
|
||||||
|
// Paper start
|
||||||
|
+ /**
|
||||||
|
+ * Get the default value this {@link GameRule}.
|
||||||
|
+ *
|
||||||
|
+ * @return the default value
|
||||||
|
+ */
|
||||||
|
+ public @NotNull T getDefaultValue() {
|
||||||
|
+ return Bukkit.getGameRuleDefault(this);
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ /**
|
||||||
|
+ * Get the current value for this {@link GameRule} and a given {@link World}.
|
||||||
|
+ *
|
||||||
|
+ * @param world the world to set the {@link GameRule} on
|
||||||
|
+ * @return the current value
|
||||||
|
+ */
|
||||||
|
+ public @NotNull T getValue(@NotNull World world) {
|
||||||
|
+ return world.getGameRuleValue(this);
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+ /**
|
||||||
|
+ * Set this {@link GameRule}'s new value.
|
||||||
|
+ *
|
||||||
|
+ * @param newValue the new value
|
||||||
|
+ * @return true if the value was successfully set
|
||||||
|
+ */
|
||||||
|
+ public boolean setValue(@NotNull World world, @NotNull T newValue) {
|
||||||
|
+ return world.setGameRule(this, newValue);
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
@Override
|
||||||
|
public @NotNull String translationKey() {
|
||||||
|
return "gamerule." + this.name;
|
||||||
|
diff --git a/src/main/java/org/bukkit/Server.java b/src/main/java/org/bukkit/Server.java
|
||||||
|
index 56e261efa654e4a6872ccea28f0461df13845d13..a8909e8cd01e2470aeb8d204ac4ba88bd76965ac 100644
|
||||||
|
--- a/src/main/java/org/bukkit/Server.java
|
||||||
|
+++ b/src/main/java/org/bukkit/Server.java
|
||||||
|
@@ -2084,6 +2084,17 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi
|
||||||
|
*/
|
||||||
|
boolean isStopping();
|
||||||
|
|
||||||
|
+ /**
|
||||||
|
+ * Get the default value for a given {@link GameRule}. This value is not
|
||||||
|
+ * guaranteed to match the current value.
|
||||||
|
+ *
|
||||||
|
+ * @param rule the rule to return a default value for
|
||||||
|
+ * @param <T> the type of GameRule
|
||||||
|
+ * @return the default value
|
||||||
|
+ * @see GameRule#getDefaultValue()
|
||||||
|
+ */
|
||||||
|
+ <T> @NotNull T getGameRuleDefault(@NotNull GameRule<T> rule);
|
||||||
|
+
|
||||||
|
/**
|
||||||
|
* Returns the {@link com.destroystokyo.paper.entity.ai.MobGoals} manager
|
||||||
|
*
|
||||||
|
diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java
|
||||||
|
index e8c0c853eb52d1473c20231660355f77b1f7e016..3a5b158db6915679f80c3d856c63abaf03bf8a97 100644
|
||||||
|
--- a/src/main/java/org/bukkit/World.java
|
||||||
|
+++ b/src/main/java/org/bukkit/World.java
|
||||||
|
@@ -3310,8 +3310,9 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
|
||||||
|
* @param rule the GameRule to check
|
||||||
|
* @param <T> the GameRule's type
|
||||||
|
* @return the current value
|
||||||
|
+ * @see GameRule#getValue(World)
|
||||||
|
*/
|
||||||
|
- @Nullable
|
||||||
|
+ @NotNull // Paper - make not null
|
||||||
|
public <T> T getGameRuleValue(@NotNull GameRule<T> rule);
|
||||||
|
|
||||||
|
/**
|
||||||
|
@@ -3321,8 +3322,9 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
|
||||||
|
* @param rule the rule to return a default value for
|
||||||
|
* @param <T> the type of GameRule
|
||||||
|
* @return the default value
|
||||||
|
+ * @see GameRule#getDefaultValue()
|
||||||
|
*/
|
||||||
|
- @Nullable
|
||||||
|
+ @NotNull // Paper - make not null
|
||||||
|
public <T> T getGameRuleDefault(@NotNull GameRule<T> rule);
|
||||||
|
|
||||||
|
/**
|
||||||
|
@@ -3332,6 +3334,7 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient
|
||||||
|
* @param newValue the new value
|
||||||
|
* @param <T> the value type of the GameRule
|
||||||
|
* @return true if the value was successfully set
|
||||||
|
+ * @see GameRule#setValue(World, Object)
|
||||||
|
*/
|
||||||
|
public <T> boolean setGameRule(@NotNull GameRule<T> rule, @NotNull T newValue);
|
||||||
|
|
||||||
53
patches/server/0929-Improve-GameRule-API.patch
Normal file
53
patches/server/0929-Improve-GameRule-API.patch
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
||||||
|
From: Jake Potrebic <jake.m.potrebic@gmail.com>
|
||||||
|
Date: Sat, 1 Jan 2022 15:53:52 -0800
|
||||||
|
Subject: [PATCH] Improve GameRule API
|
||||||
|
|
||||||
|
|
||||||
|
diff --git a/src/main/java/org/bukkit/craftbukkit/CraftServer.java b/src/main/java/org/bukkit/craftbukkit/CraftServer.java
|
||||||
|
index bfde5bbcccfaa754ec6bdf4f3817981a93e465bd..2bb191805c7fc83478ead9c1783cfbbb722a732b 100644
|
||||||
|
--- a/src/main/java/org/bukkit/craftbukkit/CraftServer.java
|
||||||
|
+++ b/src/main/java/org/bukkit/craftbukkit/CraftServer.java
|
||||||
|
@@ -2882,6 +2882,13 @@ public final class CraftServer implements Server {
|
||||||
|
return net.minecraft.server.MinecraftServer.getServer().hasStopped();
|
||||||
|
}
|
||||||
|
|
||||||
|
+ @Override
|
||||||
|
+ public <T> T getGameRuleDefault(org.bukkit.GameRule<T> rule) {
|
||||||
|
+ Validate.notNull(rule, "GameRule cannot be null");
|
||||||
|
+ return Objects.requireNonNull(CraftWorld.convert(rule, CraftWorld.getGameRuleDefinitions().get(rule.getName()).createRule()), rule + " is an unrecognized game rule");
|
||||||
|
+ }
|
||||||
|
+
|
||||||
|
+
|
||||||
|
private com.destroystokyo.paper.entity.ai.MobGoals mobGoals = new com.destroystokyo.paper.entity.ai.PaperMobGoals();
|
||||||
|
@Override
|
||||||
|
public com.destroystokyo.paper.entity.ai.MobGoals getMobGoals() {
|
||||||
|
diff --git a/src/main/java/org/bukkit/craftbukkit/CraftWorld.java b/src/main/java/org/bukkit/craftbukkit/CraftWorld.java
|
||||||
|
index f0b14914438840bd819fa7da8b76f4fcc13704d0..6190edd15206c0b97f72e6b3fa1ad48dcb5c35a4 100644
|
||||||
|
--- a/src/main/java/org/bukkit/craftbukkit/CraftWorld.java
|
||||||
|
+++ b/src/main/java/org/bukkit/craftbukkit/CraftWorld.java
|
||||||
|
@@ -1959,13 +1959,13 @@ public class CraftWorld extends CraftRegionAccessor implements World {
|
||||||
|
@Override
|
||||||
|
public <T> T getGameRuleValue(GameRule<T> rule) {
|
||||||
|
Validate.notNull(rule, "GameRule cannot be null");
|
||||||
|
- return this.convert(rule, this.getHandle().getGameRules().getRule(CraftWorld.getGameRulesNMS().get(rule.getName())));
|
||||||
|
+ return Objects.requireNonNull(convert(rule, this.getHandle().getGameRules().getRule(CraftWorld.getGameRulesNMS().get(rule.getName()))), rule + " is an unrecognized game rule"); // Paper - make not null
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public <T> T getGameRuleDefault(GameRule<T> rule) {
|
||||||
|
Validate.notNull(rule, "GameRule cannot be null");
|
||||||
|
- return this.convert(rule, CraftWorld.getGameRuleDefinitions().get(rule.getName()).createRule());
|
||||||
|
+ return Objects.requireNonNull(convert(rule, CraftWorld.getGameRuleDefinitions().get(rule.getName()).createRule()), rule + " is an unrecognized game rule"); // Paper - make not null
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
@@ -1985,7 +1985,7 @@ public class CraftWorld extends CraftRegionAccessor implements World {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
- private <T> T convert(GameRule<T> rule, GameRules.Value<?> value) {
|
||||||
|
+ public static <T> T convert(GameRule<T> rule, GameRules.Value<?> value) { // Paper - make static
|
||||||
|
if (value == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue
Block a user