cloud.commandframework.bukkit.BukkitBrigadierMapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloud-bukkit Show documentation
Show all versions of cloud-bukkit Show documentation
Command framework and dispatcher for the JVM
//
// MIT License
//
// Copyright (c) 2022 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.bukkit;
import cloud.commandframework.arguments.parser.ArgumentParser;
import cloud.commandframework.arguments.standard.UUIDArgument;
import cloud.commandframework.brigadier.CloudBrigadierManager;
import cloud.commandframework.bukkit.argument.NamespacedKeyArgument;
import cloud.commandframework.bukkit.internal.CommandBuildContextSupplier;
import cloud.commandframework.bukkit.internal.MinecraftArgumentTypes;
import cloud.commandframework.bukkit.internal.RegistryReflection;
import cloud.commandframework.bukkit.parsers.BlockPredicateArgument;
import cloud.commandframework.bukkit.parsers.EnchantmentArgument;
import cloud.commandframework.bukkit.parsers.ItemStackArgument;
import cloud.commandframework.bukkit.parsers.ItemStackPredicateArgument;
import cloud.commandframework.bukkit.parsers.location.Location2DArgument;
import cloud.commandframework.bukkit.parsers.location.LocationArgument;
import cloud.commandframework.bukkit.parsers.selector.MultipleEntitySelectorArgument;
import cloud.commandframework.bukkit.parsers.selector.MultiplePlayerSelectorArgument;
import cloud.commandframework.bukkit.parsers.selector.SingleEntitySelectorArgument;
import cloud.commandframework.bukkit.parsers.selector.SinglePlayerSelectorArgument;
import com.mojang.brigadier.arguments.ArgumentType;
import com.mojang.brigadier.arguments.StringArgumentType;
import io.leangen.geantyref.GenericTypeReflector;
import io.leangen.geantyref.TypeToken;
import java.lang.reflect.Constructor;
import java.util.function.Supplier;
import java.util.logging.Level;
import org.bukkit.NamespacedKey;
import org.checkerframework.checker.nullness.qual.NonNull;
/**
* Class which handles mapping argument types to their NMS Brigadier counterpart on Bukkit platforms.
*
* @param Command sender type
*/
public final class BukkitBrigadierMapper {
private final BukkitCommandManager commandManager;
private final CloudBrigadierManager brigadierManager;
/**
* Class that handles mapping argument types to Brigadier for Bukkit (Commodore) and Paper.
*
* @param commandManager The {@link BukkitCommandManager} to use for mapping
* @param brigadierManager The {@link CloudBrigadierManager} to use for mapping
*/
public BukkitBrigadierMapper(
final @NonNull BukkitCommandManager commandManager,
final @NonNull CloudBrigadierManager brigadierManager
) {
this.commandManager = commandManager;
this.brigadierManager = brigadierManager;
this.registerMappings();
}
@SuppressWarnings("unused")
private void registerMappings() {
/* UUID nms argument is a 1.16+ feature */
try {
final Class> uuid = MinecraftArgumentTypes.getClassByKey(NamespacedKey.minecraft("uuid"));
/* Map UUID */
this.mapSimpleNMS(new TypeToken>() {
}, "uuid");
} catch (final IllegalArgumentException ignore) {
// < 1.16
}
/* Map NamespacedKey */
this.mapSimpleNMS(new TypeToken>() {
}, "resource_location", true);
/* Map Enchantment */
try {
// Pre-1.19.3
final Class> ench = MinecraftArgumentTypes.getClassByKey(NamespacedKey.minecraft(
"item_enchantment"));
this.mapSimpleNMS(new TypeToken>() {
}, "item_enchantment");
} catch (final IllegalArgumentException ignore) {
// 1.19.3+
this.mapNMS(new TypeToken>() {
}, this::modernEnchantment);
}
/* Map Item arguments */
this.mapSimpleContextNMS(new TypeToken>() {
}, "item_stack");
this.mapSimpleContextNMS(new TypeToken>() {
}, "item_predicate");
/* Map Block arguments */
this.mapSimpleContextNMS(new TypeToken>() {
}, "block_predicate");
/* Map Entity Selectors */
this.mapNMS(new TypeToken>() {
}, this.entitySelectorArgumentSupplier(true, false));
this.mapNMS(new TypeToken>() {
}, this.entitySelectorArgumentSupplier(true, true));
this.mapNMS(new TypeToken>() {
}, this.entitySelectorArgumentSupplier(false, false));
this.mapNMS(new TypeToken>() {
}, this.entitySelectorArgumentSupplier(false, true));
/* Map Vec3 */
this.mapNMS(new TypeToken>() {
}, this::argumentVec3);
/* Map Vec2 */
this.mapNMS(new TypeToken>() {
}, this::argumentVec2);
}
private ArgumentType modernEnchantment() {
try {
return (ArgumentType) MinecraftArgumentTypes.getClassByKey(NamespacedKey.minecraft("resource_key"))
.getDeclaredConstructors()[0]
.newInstance(RegistryReflection.registryKey(RegistryReflection.registryByName("enchantment")));
} catch (final Exception e) {
this.commandManager.getOwningPlugin().getLogger().log(Level.INFO, "Failed to retrieve enchantment argument", e);
return fallbackType();
}
}
/**
* @param single Whether the selector is for a single entity only (true), or for multiple entities (false)
* @param playersOnly Whether the selector is for players only (true), or for all entities (false)
* @return The NMS ArgumentType
*/
private @NonNull Supplier> entitySelectorArgumentSupplier(
final boolean single,
final boolean playersOnly
) {
return () -> {
try {
final Constructor constructor =
MinecraftArgumentTypes.getClassByKey(NamespacedKey.minecraft("entity")).getDeclaredConstructors()[0];
constructor.setAccessible(true);
return (ArgumentType) constructor.newInstance(single, playersOnly);
} catch (final Exception e) {
this.commandManager.getOwningPlugin().getLogger().log(Level.INFO, "Failed to retrieve Selector Argument", e);
return fallbackType();
}
};
}
private @NonNull ArgumentType argumentVec3() {
try {
return MinecraftArgumentTypes.getClassByKey(NamespacedKey.minecraft("vec3"))
.getDeclaredConstructor(boolean.class)
.newInstance(true);
} catch (final Exception e) {
this.commandManager.getOwningPlugin().getLogger().log(Level.INFO, "Failed to retrieve Vec3D argument", e);
return fallbackType();
}
}
private @NonNull ArgumentType argumentVec2() {
try {
return MinecraftArgumentTypes.getClassByKey(NamespacedKey.minecraft("vec2"))
.getDeclaredConstructor(boolean.class)
.newInstance(true);
} catch (final Exception e) {
this.commandManager.getOwningPlugin().getLogger().log(Level.INFO, "Failed to retrieve Vec2 argument", e);
return fallbackType();
}
}
/**
* Attempt to register a mapping between a cloud argument parser type and an NMS brigadier argument type which
* has a single-arg constructor taking CommandBuildContext. Will fall back to behavior
* of {@link #mapSimpleNMS(TypeToken, String)} on older versions.
*
* @param type Type to map
* @param argument parser type
* @param argumentId registry id of argument type
* @since 1.7.0
*/
public > void mapSimpleContextNMS(
final @NonNull TypeToken type,
final @NonNull String argumentId
) {
final Constructor ctr = MinecraftArgumentTypes.getClassByKey(NamespacedKey.minecraft(argumentId))
.getDeclaredConstructors()[0];
this.mapNMS(type, () -> {
final Object[] args = ctr.getParameterCount() == 1
? new Object[]{CommandBuildContextSupplier.commandBuildContext()}
: new Object[]{};
try {
return (ArgumentType) ctr.newInstance(args);
} catch (final ReflectiveOperationException e) {
throw new RuntimeException(e);
}
});
}
/**
* Attempt to register a mapping between a cloud argument parser type and an NMS brigadier argument type which
* has a no-args constructor.
*
* @param type Type to map
* @param argument parser type
* @param argumentId registry id of argument type
* @since 1.5.0
*/
public > void mapSimpleNMS(
final @NonNull TypeToken type,
final @NonNull String argumentId
) {
this.mapSimpleNMS(type, argumentId, false);
}
/**
* Attempt to register a mapping between a cloud argument parser type and an NMS brigadier argument type which
* has a no-args constructor.
*
* @param type Type to map
* @param argument parser type
* @param argumentId registry id of argument type
* @param useCloudSuggestions whether to use cloud suggestions
* @since 1.6.0
*/
public > void mapSimpleNMS(
final @NonNull TypeToken type,
final @NonNull String argumentId,
final boolean useCloudSuggestions
) {
final Constructor constructor;
try {
final Class nmsArgument = MinecraftArgumentTypes.getClassByKey(NamespacedKey.minecraft(argumentId));
constructor = nmsArgument.getConstructor();
} catch (final RuntimeException | ReflectiveOperationException e) {
this.commandManager.getOwningPlugin().getLogger().log(
Level.WARNING,
String.format("Failed to create mapping for NMS brigadier argument type '%s'.", argumentId),
e
);
return;
}
this.brigadierManager.registerMapping(type, builder -> {
builder.to(argument -> {
try {
return (ArgumentType) constructor.newInstance();
} catch (final ReflectiveOperationException e) {
this.commandManager.getOwningPlugin().getLogger().log(
Level.WARNING,
String.format(
"Failed to create instance of brigadier argument type '%s'.",
GenericTypeReflector.erase(type.getType()).getCanonicalName()
),
e
);
return fallbackType();
}
});
if (useCloudSuggestions) {
builder.cloudSuggestions();
}
});
}
/**
* Attempt to register a mapping between a type and a NMS argument type
*
* @param type Type to map
* @param argumentTypeSupplier Supplier of the NMS argument type
* @param argument parser type
* @since 1.5.0
*/
public > void mapNMS(
final @NonNull TypeToken type,
final @NonNull Supplier> argumentTypeSupplier
) {
this.brigadierManager.registerMapping(type, builder ->
builder.to(argument -> argumentTypeSupplier.get())
);
}
private static @NonNull StringArgumentType fallbackType() {
return StringArgumentType.word();
}
/**
* Attempt to register a mapping between a type and a NMS argument type
*
* @param type Type to map
* @param constructor Constructor that construct the NMS argument type
* @deprecated use {@link #mapSimpleNMS(TypeToken, String)} instead
*/
@Deprecated
public void mapSimpleNMS(
final @NonNull Class type,
final @NonNull Constructor constructor
) {
this.brigadierManager.registerDefaultArgumentTypeSupplier(type, () -> {
try {
return (ArgumentType) constructor.newInstance();
} catch (final ReflectiveOperationException e) {
this.commandManager.getOwningPlugin().getLogger().log(
Level.WARNING,
String.format("Failed to map brigadier argument type '%s'", type.getCanonicalName()),
e
);
return fallbackType();
}
});
}
/**
* Attempt to register a mapping between a type and a NMS argument type
*
* @param type Type to map
* @param argumentTypeSupplier Supplier of the NMS argument type
* @deprecated use {@link #mapNMS(TypeToken, Supplier)} instead
*/
@Deprecated
public void mapComplexNMS(
final @NonNull Class type,
final @NonNull Supplier> argumentTypeSupplier
) {
this.brigadierManager.registerDefaultArgumentTypeSupplier(type, argumentTypeSupplier);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy