zhdev/oblak
1
0
Fork 0
Code Issues Pull requests Activity

paper: Add KeyedWorldArgument (#293)

Browse source
This commit is contained in:
Jake Potrebic 2021-08-31 13:08:24 -07:00 • committed by Jason
parent 4037e8e393
commit ffac750f0d
6 changed files with 260 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added
- Kotlin: Support for suspending command functions using `AnnotationParser<C>.installCoroutineSupport()`
- Flags can be bound to a permission
- Paper: Implement KeyedWorldArgument for matching worlds by their namespaced key
### Changed
- Added `executeFuture` to `CommandExecutionHandler` which is now used internally. By default, this delegates to the old

2
build-logic/src/main/kotlin/Versions.kt
View file

@ -18,7 +18,7 @@ object Versions {
const val cloudburst = "1.0.0-SNAPSHOT"
const val adventureApi = "4.8.1"
const val adventurePlatform = "4.0.0-SNAPSHOT"
const val paperApi = "1.15.2-R0.1-SNAPSHOT"
const val paperApi = "1.16.5-R0.1-SNAPSHOT"
const val velocityApi = "1.1.0"
const val spongeApi7 = "7.3.0"
const val jetbrainsAnnotations = "20.1.0"

2
cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperBrigadierListener.java
View file

@ -55,7 +55,7 @@ class PaperBrigadierListener<C> implements Listener {
this.brigadierManager.brigadierSenderMapper(sender ->
this.paperCommandManager.getCommandSenderMapper().apply(sender.getBukkitSender()));
new BukkitBrigadierMapper<>(this.paperCommandManager, this.brigadierManager);
new PaperBrigadierMapper<>(new BukkitBrigadierMapper<>(this.paperCommandManager, this.brigadierManager));
this.brigadierManager
.backwardsBrigadierSenderMapper(new BukkitBackwardsBrigadierSenderMapper<>(this.paperCommandManager));

56
cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/PaperBrigadierMapper.java Normal file
View file

@ -0,0 +1,56 @@
//
// MIT License
//
// Copyright (c) 2021 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.paper;
import cloud.commandframework.bukkit.BukkitBrigadierMapper;
import cloud.commandframework.bukkit.internal.CraftBukkitReflection;
import cloud.commandframework.paper.argument.KeyedWorldArgument;
import io.leangen.geantyref.TypeToken;
import org.bukkit.World;
import org.checkerframework.checker.nullness.qual.NonNull;
/**
* Brigadier mappings for Paper native Brigadier. This is currently only used when the PaperBrigadierListener is in use,
* not when the CloudCommodoreManager is in use on Paper. This is because all argument types registered here require
* Paper 1.15+ anyways.
*
* @param <C> sender type
*/
final class PaperBrigadierMapper<C> {
PaperBrigadierMapper(
final @NonNull BukkitBrigadierMapper<C> mapper
) {
this.registerMappings(mapper);
}
private void registerMappings(final @NonNull BukkitBrigadierMapper<C> mapper) {
final Class<?> keyed = CraftBukkitReflection.findClass("org.bukkit.Keyed");
if (keyed != null && keyed.isAssignableFrom(World.class)) {
mapper.mapSimpleNMS(new TypeToken<KeyedWorldArgument.Parser<C>>() {
}, "resource_location");
}
}
}

174
cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/argument/KeyedWorldArgument.java Normal file
View file

@ -0,0 +1,174 @@
//
// MIT License
//
// Copyright (c) 2021 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.paper.argument;
import cloud.commandframework.ArgumentDescription;
import cloud.commandframework.arguments.CommandArgument;
import cloud.commandframework.arguments.parser.ArgumentParseResult;
import cloud.commandframework.arguments.parser.ArgumentParser;
import cloud.commandframework.bukkit.parsers.WorldArgument;
import cloud.commandframework.context.CommandContext;
import cloud.commandframework.exceptions.parsing.NoInputProvidedException;
import org.bukkit.Bukkit;
import org.bukkit.NamespacedKey;
import org.bukkit.World;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import java.util.ArrayList;
import java.util.List;
import java.util.Queue;
import java.util.function.BiFunction;
/**
* Argument type that parses Bukkit {@link World worlds} from a {@link NamespacedKey}.
*
* @param <C> Command sender type
*/
public class KeyedWorldArgument<C> extends CommandArgument<C, World> {
protected KeyedWorldArgument(
final boolean required,
final @NonNull String name,
final @NonNull String defaultValue,
final @Nullable BiFunction<CommandContext<C>, String, List<String>> suggestionsProvider,
final @NonNull ArgumentDescription defaultDescription
) {
super(required, name, new Parser<>(), defaultValue, World.class, suggestionsProvider, defaultDescription);
}
/**
* Create a new {@link Builder}.
*
* @param name Name of the argument
* @param <C> Command sender type
* @return Created builder
*/
public static <C> KeyedWorldArgument.@NonNull Builder<C> builder(final @NonNull String name) {
return new KeyedWorldArgument.Builder<>(name);
}
/**
* Create a new required {@link KeyedWorldArgument}.
*
* @param name Argument name
* @param <C> Command sender type
* @return Created argument
*/
public static <C> @NonNull KeyedWorldArgument<C> of(final @NonNull String name) {
return KeyedWorldArgument.<C>builder(name).asRequired().build();
}
/**
* Create a new optional {@link KeyedWorldArgument}.
*
* @param name Argument name
* @param <C> Command sender type
* @return Created argument
*/
public static <C> @NonNull KeyedWorldArgument<C> optional(final @NonNull String name) {
return KeyedWorldArgument.<C>builder(name).asOptional().build();
}
/**
* Create a new {@link KeyedWorldArgument} with the specified default value.
*
* @param name Argument name
* @param defaultValue Default value
* @param <C> Command sender type
* @return Created argument
*/
public static <C> @NonNull KeyedWorldArgument<C> optional(
final @NonNull String name,
final @NonNull String defaultValue
) {
return KeyedWorldArgument.<C>builder(name).asOptionalWithDefault(defaultValue).build();
}
public static final class Builder<C> extends CommandArgument.TypedBuilder<C, World, Builder<C>> {
private Builder(final @NonNull String name) {
super(World.class, name);
}
@Override
public @NonNull KeyedWorldArgument<C> build() {
return new KeyedWorldArgument<>(
this.isRequired(),
this.getName(),
this.getDefaultValue(),
this.getSuggestionsProvider(),
this.getDefaultDescription()
);
}
}
public static final class Parser<C> implements ArgumentParser<C, World> {
@Override
public @NonNull ArgumentParseResult<@NonNull World> parse(
@NonNull final CommandContext<@NonNull C> commandContext,
@NonNull final Queue<@NonNull String> inputQueue
) {
final String input = inputQueue.peek();
if (input == null) {
return ArgumentParseResult.failure(new NoInputProvidedException(
Parser.class,
commandContext
));
}
final NamespacedKey key = NamespacedKey.fromString(input);
if (key == null) {
return ArgumentParseResult.failure(new WorldArgument.WorldParseException(input, commandContext));
}
final World world = Bukkit.getWorld(key);
if (world == null) {
return ArgumentParseResult.failure(new WorldArgument.WorldParseException(input, commandContext));
}
inputQueue.remove();
return ArgumentParseResult.success(world);
}
@Override
public @NonNull List<@NonNull String> suggestions(
final @NonNull CommandContext<C> commandContext,
final @NonNull String input
) {
final List<String> completions = new ArrayList<>();
for (final World world : Bukkit.getWorlds()) {
if (world.getKey().getNamespace().equals(NamespacedKey.MINECRAFT)) {
completions.add(world.getKey().getKey());
} else {
completions.add(world.getKey().toString());
}
}
return completions;
}
}
}

27
cloud-minecraft/cloud-paper/src/main/java/cloud/commandframework/paper/argument/package-info.java Normal file
View file

@ -0,0 +1,27 @@
//
// MIT License
//
// Copyright (c) 2021 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.
//
/**
* Paper specific command arguments
*/
package cloud.commandframework.paper.argument;