Add FeatureFlag API
This commit is contained in:
@@ -1,17 +1,24 @@
|
||||
package org.bukkit;
|
||||
|
||||
// Paper start - overhaul FeatureFlag API
|
||||
import com.google.common.base.Preconditions;
|
||||
import java.util.List;
|
||||
import net.kyori.adventure.key.Key;
|
||||
import net.kyori.adventure.util.Index;
|
||||
import org.intellij.lang.annotations.Subst;
|
||||
// Paper end - overhaul FeatureFlag API
|
||||
import org.jetbrains.annotations.ApiStatus;
|
||||
|
||||
/**
|
||||
* This represents a Feature Flag for a World.
|
||||
* <br>
|
||||
* Flags which are unavailable in the current version will be null and/or
|
||||
* removed.
|
||||
* This represents a Feature Flag for a {@link io.papermc.paper.world.flag.FeatureFlagSetHolder}.
|
||||
*/
|
||||
@ApiStatus.Experimental
|
||||
public interface FeatureFlag extends Keyed {
|
||||
|
||||
public static final FeatureFlag VANILLA = Bukkit.getUnsafe().getFeatureFlag(NamespacedKey.minecraft("vanilla"));
|
||||
// Paper start - overhaul FeatureFlag API
|
||||
/**
|
||||
* The {@code vanilla} feature flag.
|
||||
*/
|
||||
FeatureFlag VANILLA = create("vanilla");
|
||||
|
||||
/**
|
||||
* <strong>AVAILABLE BETWEEN VERSIONS:</strong> 1.19.3 - 1.21.1
|
||||
@@ -19,18 +26,19 @@ public interface FeatureFlag extends Keyed {
|
||||
* @deprecated not available since 1.21.2
|
||||
*/
|
||||
@Deprecated(since = "1.21.2")
|
||||
public static final FeatureFlag BUNDLE = Bukkit.getUnsafe().getFeatureFlag(NamespacedKey.minecraft("bundle"));
|
||||
FeatureFlag BUNDLE = deprecated("bundle");
|
||||
|
||||
/**
|
||||
* <strong>AVAILABLE BETWEEN VERSIONS:</strong> 1.19 - 1.19.4
|
||||
*
|
||||
* @deprecated not available since 1.20
|
||||
* The {@code trade_rebalance} feature flag.
|
||||
*/
|
||||
@Deprecated(since = "1.20.2")
|
||||
public static final FeatureFlag UPDATE_1_20 = Bukkit.getUnsafe().getFeatureFlag(NamespacedKey.minecraft("update_1_20"));
|
||||
@Deprecated(since = "1.20")
|
||||
FeatureFlag UPDATE_1_20 = deprecated("update_1_20");
|
||||
|
||||
@ApiStatus.Experimental // Paper - add missing annotation
|
||||
public static final FeatureFlag TRADE_REBALANCE = Bukkit.getUnsafe().getFeatureFlag(NamespacedKey.minecraft("trade_rebalance"));
|
||||
FeatureFlag TRADE_REBALANCE = create("trade_rebalance");
|
||||
|
||||
/**
|
||||
* <strong>AVAILABLE BETWEEN VERSIONS:</strong> 1.20.5 - 1.20.6
|
||||
@@ -38,7 +46,7 @@ public interface FeatureFlag extends Keyed {
|
||||
* @deprecated not available since 1.21
|
||||
*/
|
||||
@Deprecated(since = "1.21")
|
||||
public static final FeatureFlag UPDATE_121 = Bukkit.getUnsafe().getFeatureFlag(NamespacedKey.minecraft("update_1_21"));
|
||||
FeatureFlag UPDATE_121 = deprecated("update_1_21");
|
||||
|
||||
/**
|
||||
* <strong>AVAILABLE BETWEEN VERSIONS:</strong> 1.21.2 - 1.21.3
|
||||
@@ -46,12 +54,28 @@ public interface FeatureFlag extends Keyed {
|
||||
* @deprecated not available since 1.21.4
|
||||
*/
|
||||
@Deprecated(since = "1.21.4")
|
||||
public static final FeatureFlag WINTER_DROP = Bukkit.getUnsafe().getFeatureFlag(NamespacedKey.minecraft("winter_drop"));
|
||||
FeatureFlag WINTER_DROP = deprecated("winter_drop");
|
||||
|
||||
@ApiStatus.Experimental // Paper - add missing annotation
|
||||
public static final FeatureFlag REDSTONE_EXPERIMENTS = Bukkit.getUnsafe().getFeatureFlag(NamespacedKey.minecraft("redstone_experiments"));
|
||||
FeatureFlag REDSTONE_EXPERIMENTS = create("redstone_experiments");
|
||||
|
||||
@ApiStatus.Experimental // Paper - add missing annotation
|
||||
public static final FeatureFlag MINECART_IMPROVEMENTS = Bukkit.getUnsafe().getFeatureFlag(NamespacedKey.minecraft("minecart_improvements"));
|
||||
FeatureFlag MINECART_IMPROVEMENTS = create("minecart_improvements");
|
||||
|
||||
/**
|
||||
* An index of all feature flags.
|
||||
*/
|
||||
Index<Key, FeatureFlag> ALL_FLAGS = Index.create(FeatureFlag::key, List.copyOf(FeatureFlagImpl.ALL_FLAGS));
|
||||
|
||||
private static FeatureFlag create(@Subst("vanilla") final String name) {
|
||||
final FeatureFlag flag = new FeatureFlagImpl(NamespacedKey.minecraft(name));
|
||||
Preconditions.checkState(FeatureFlagImpl.ALL_FLAGS.add(flag), "Tried to add duplicate feature flag: " + name);
|
||||
return flag;
|
||||
}
|
||||
|
||||
private static FeatureFlag deprecated(@Subst("vanilla") final String name) {
|
||||
return new FeatureFlagImpl.Deprecated(NamespacedKey.minecraft(name));
|
||||
}
|
||||
// Paper end - overhaul FeatureFlag API
|
||||
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user