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

✨ fix-commodore (#27)

Browse source
This commit is contained in:
Alexander Söderberg 2020-10-06 12:39:06 +02:00 • committed by GitHub
parent 8f8f98b189
commit c3469706ab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 435 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

276
examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/ExamplePlugin.java Normal file
View file

@ -0,0 +1,276 @@
//
// MIT License
//
// Copyright (c) 2020 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.examples.bukkit;
import cloud.commandframework.Command;
import cloud.commandframework.CommandTree;
import cloud.commandframework.Description;
import cloud.commandframework.MinecraftHelp;
import cloud.commandframework.annotations.AnnotationParser;
import cloud.commandframework.annotations.Argument;
import cloud.commandframework.annotations.CommandDescription;
import cloud.commandframework.annotations.CommandMethod;
import cloud.commandframework.annotations.CommandPermission;
import cloud.commandframework.annotations.Confirmation;
import cloud.commandframework.annotations.Flag;
import cloud.commandframework.annotations.specifier.Greedy;
import cloud.commandframework.arguments.CommandArgument;
import cloud.commandframework.arguments.parser.ParserParameters;
import cloud.commandframework.arguments.parser.StandardParameters;
import cloud.commandframework.bukkit.BukkitCommandManager;
import cloud.commandframework.bukkit.BukkitCommandMetaBuilder;
import cloud.commandframework.bukkit.CloudBukkitCapabilities;
import cloud.commandframework.bukkit.arguments.selector.SingleEntitySelector;
import cloud.commandframework.bukkit.parsers.WorldArgument;
import cloud.commandframework.bukkit.parsers.selector.SingleEntitySelectorArgument;
import cloud.commandframework.execution.CommandExecutionCoordinator;
import cloud.commandframework.extra.confirmation.CommandConfirmationManager;
import cloud.commandframework.meta.CommandMeta;
import cloud.commandframework.paper.PaperCommandManager;
import cloud.commandframework.types.tuples.Triplet;
import io.leangen.geantyref.TypeToken;
import net.kyori.adventure.platform.bukkit.BukkitAudiences;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.format.NamedTextColor;
import org.bukkit.ChatColor;
import org.bukkit.Location;
import org.bukkit.Material;
import org.bukkit.World;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.meta.ItemMeta;
import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.util.Vector;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;
/**
* Example plugin class
*/
public final class ExamplePlugin extends JavaPlugin {
private BukkitCommandManager<CommandSender> manager;
private BukkitAudiences bukkitAudiences;
private MinecraftHelp<CommandSender> minecraftHelp;
private CommandConfirmationManager<CommandSender> confirmationManager;
private AnnotationParser<CommandSender> annotationParser;
@Override
public void onEnable() {
//
// This is a function that will provide a command execution coordinator that parses and executes commands
// asynchronously
//
// final Function<CommandTree<CommandSender>, CommandExecutionCoordinator<CommandSender>> executionCoordinatorFunction =
// AsynchronousCommandExecutionCoordinator.<CommandSender>newBuilder().build();
//
// However, in this example it is fine for us to run everything synchronously
//
final Function<CommandTree<CommandSender>, CommandExecutionCoordinator<CommandSender>> executionCoordinatorFunction =
CommandExecutionCoordinator.simpleCoordinator();
//
// This function maps the command sender type of our choice to the bukkit command sender.
// However, in this example we use the Bukkit command sender, and so we just need to map it
// to itself
//
final Function<CommandSender, CommandSender> mapperFunction = Function.identity();
try {
this.manager = new PaperCommandManager<>(
/* Owning plugin */ this,
/* Coordinator function */ executionCoordinatorFunction,
/* Command Sender -> C */ mapperFunction,
/* C -> Command Sender */ mapperFunction
);
} catch (final Exception e) {
this.getLogger().severe("Failed to initialize the command manager");
/* Disable the plugin */
this.getServer().getPluginManager().disablePlugin(this);
return;
}
//
// Create a BukkitAudiences instance (adventure) in order to use the minecraft-extras
// help system
//
this.bukkitAudiences = BukkitAudiences.create(this);
//
// Create the Minecraft help menu system
//
this.minecraftHelp = new MinecraftHelp<>(
/* Help Prefix */ "/example help",
/* Audience mapper */ this.bukkitAudiences::sender,
/* Manager */ this.manager
);
//
// Register Brigadier mappings
//
if (manager.queryCapability(CloudBukkitCapabilities.BRIGADIER)) {
manager.registerBrigadier();
}
//
// Register asynchronous completions
//
if (manager.queryCapability(CloudBukkitCapabilities.ASYNCHRONOUS_COMPLETION)) {
((PaperCommandManager<CommandSender>) this.manager).registerAsynchronousCompletions();
}
//
// Create the confirmation manager. This allows us to require certain commands to be
// confirmed before they can be executed
//
this.confirmationManager = new CommandConfirmationManager<>(
/* Timeout */ 30L,
/* Timeout unit */ TimeUnit.SECONDS,
/* Action when confirmation is required */ context -> context.getCommandContext().getSender().sendMessage(
ChatColor.RED + "Confirmation required. Confirm using /example confirm."),
/* Action when no confirmation is pending */ sender -> sender.sendMessage(
ChatColor.RED + "You don't have any pending commands.")
);
//
// Register the confirmation processor. This will enable confirmations for commands that require it
//
this.confirmationManager.registerConfirmationProcessor(manager);
//
// Create the annotation parser. This allows you to define commands using methods annotated with
// @CommandMethod
//
final Function<ParserParameters, CommandMeta> commandMetaFunction = p ->
BukkitCommandMetaBuilder.builder()
// This will allow you to decorate commands with descriptions
.withDescription(p.get(StandardParameters.DESCRIPTION, "No description"))
.build();
this.annotationParser = new AnnotationParser<>(
/* Manager */ this.manager,
/* Command sender type */ CommandSender.class,
/* Mapper for command meta instances */ commandMetaFunction
);
//
// Create the commands
//
this.constructCommands();
}
private void constructCommands() {
//
// Parse all @CommandMethod-annotated methods
//
this.annotationParser.parse(this);
//
// Base command builder
//
final Command.Builder<CommandSender> builder = this.manager.commandBuilder("example");
//
// Add a confirmation command
//
this.manager.command(builder.literal("confirm")
.meta("description", "Confirm a pending command")
.handler(this.confirmationManager.createConfirmationExecutionHandler()));
//
// Create a world argument
//
final CommandArgument<CommandSender, World> worldArgument = WorldArgument.of("world");
//
// Create a teleportation command
//
this.manager.command(builder.literal("teleport")
.literal("me")
// Require a player sender
.withSenderType(Player.class)
.argument(worldArgument, Description.of("World name"))
.argumentTriplet(
"coords",
TypeToken.get(Vector.class),
Triplet.of("x", "y", "z"),
Triplet.of(Integer.class, Integer.class, Integer.class),
triplet -> new Vector(triplet.getFirst(), triplet.getSecond(), triplet.getThird()),
Description.of("Coordinates"))
.handler(context -> {
final Player player = (Player) context.getSender();
final World world = context.get(worldArgument);
final Vector coords = context.get("coords");
final Location location = coords.toLocation(world);
player.teleport(location);
}))
.command(builder.literal("teleport")
.literal("entity")
.withSenderType(Player.class)
.argument(SingleEntitySelectorArgument.of("entity"),
Description.of("Entity to teleport"))
.literal("here")
.handler(commandContext -> {
final Player player = (Player) commandContext.getSender();
final SingleEntitySelector singleEntitySelector = commandContext.get("entity");
if (singleEntitySelector.hasAny()) {
singleEntitySelector.getEntity().teleport(player);
player.sendMessage(ChatColor.GREEN + "The entity was teleported to you!");
} else {
player.sendMessage(ChatColor.RED + "No entity matched your query.");
}
}));
}
@CommandMethod("example help [query]")
@CommandDescription("Help menu")
private void commandHelp(final @NonNull CommandSender sender,
final @Argument("query") @Greedy String query) {
this.minecraftHelp.queryCommands(query == null ? "" : query, sender);
}
@Confirmation
@CommandMethod("example clear")
@CommandDescription("Clear your inventory")
@CommandPermission("example.clear")
private void commandClear(final @NonNull Player player) {
player.getInventory().clear();
this.bukkitAudiences.player(player)
.sendMessage(Component.text("Your inventory has been cleared", NamedTextColor.GOLD));
}
@CommandMethod("example give <material> <amount>")
@CommandDescription("Give yourself an item")
private void commandGive(final @NonNull Player player,
final @NonNull @Argument("material") Material material,
final @Argument("amount") int number,
final @Nullable @Flag("color") ChatColor nameColor) {
final ItemStack itemStack = new ItemStack(material, number);
String itemName = String.format("%s's %s",
player.getName(),
material.name()
.toLowerCase()
.replace('_', ' '));
if (nameColor != null) {
itemName = nameColor + itemName;
}
final ItemMeta meta = itemStack.getItemMeta();
if (meta != null) {
meta.setDisplayName(itemName);
itemStack.setItemMeta(meta);
}
player.getInventory().addItem(itemStack);
player.sendMessage(ChatColor.GREEN + String.format("You have been given %d x %s", number, material));
}
}

28
examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/package-info.java Normal file
View file

@ -0,0 +1,28 @@
//
// MIT License
//
// Copyright (c) 2020 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.
//
/**
* Bukkit example plugin
*/
package cloud.commandframework.examples.bukkit;

4
examples/example-bukkit/src/main/resources/plugin.yml Normal file
View file

@ -0,0 +1,4 @@
name: ExamplePlugin
version: 1.0.0
api-version: 1.13
main: cloud.commandframework.examples.bukkit.ExamplePlugin