cloud.commandframework.bukkit.parsers.location.LocationArgument 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.parsers.location;
import cloud.commandframework.ArgumentDescription;
import cloud.commandframework.arguments.CommandArgument;
import cloud.commandframework.arguments.parser.ArgumentParseResult;
import cloud.commandframework.arguments.parser.ArgumentParser;
import cloud.commandframework.arguments.standard.IntegerArgument;
import cloud.commandframework.bukkit.BukkitCaptionKeys;
import cloud.commandframework.bukkit.BukkitCommandContextKeys;
import cloud.commandframework.captions.Caption;
import cloud.commandframework.captions.CaptionVariable;
import cloud.commandframework.context.CommandContext;
import cloud.commandframework.exceptions.parsing.ParserException;
import io.leangen.geantyref.TypeToken;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import java.util.Queue;
import java.util.function.BiFunction;
import java.util.stream.Collectors;
import org.apiguardian.api.API;
import org.bukkit.Bukkit;
import org.bukkit.Location;
import org.bukkit.command.BlockCommandSender;
import org.bukkit.command.CommandSender;
import org.bukkit.entity.Entity;
import org.bukkit.util.Vector;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* Argument parser that parses {@link Location} from three doubles. This will use the command
* senders world when it exists, or else it'll use the first loaded Bukkit world
*
* @param Command sender type
* @since 1.1.0
*/
public final class LocationArgument extends CommandArgument {
private LocationArgument(
final boolean required,
final @NonNull String name,
final @NonNull String defaultValue,
final @Nullable BiFunction, String, List> suggestionsProvider,
final @NonNull ArgumentDescription defaultDescription,
final @NonNull Collection<@NonNull BiFunction<@NonNull CommandContext,
@NonNull Queue<@NonNull String>, @NonNull ArgumentParseResult>> argumentPreprocessors
) {
super(
required,
name,
new LocationParser<>(),
defaultValue,
TypeToken.get(Location.class),
suggestionsProvider,
defaultDescription,
argumentPreprocessors
);
}
/**
* Create a new {@link Builder}.
*
* @param name argument name
* @param sender type
* @return new {@link Builder}
* @since 1.8.0
*/
@API(status = API.Status.STABLE, since = "1.8.0")
public static @NonNull Builder builder(final @NonNull String name) {
return new Builder<>(name);
}
/**
* Create a new builder
*
* @param name Name of the argument
* @param Command sender type
* @return Created builder
* @deprecated prefer {@link #builder(String)}
*/
@API(status = API.Status.DEPRECATED, since = "1.8.0")
@Deprecated
public static @NonNull Builder newBuilder(final @NonNull String name) {
return builder(name);
}
/**
* Create a new required argument
*
* @param name Argument name
* @param Command sender type
* @return Constructed argument
*/
public static @NonNull CommandArgument of(
final @NonNull String name
) {
return LocationArgument.builder(name).asRequired().build();
}
/**
* Create a new optional argument
*
* @param name Argument name
* @param Command sender type
* @return Constructed argument
*/
public static @NonNull CommandArgument optional(
final @NonNull String name
) {
return LocationArgument.builder(name).asOptional().build();
}
public static final class Builder extends CommandArgument.Builder {
private Builder(
final @NonNull String name
) {
super(
TypeToken.get(Location.class),
name
);
}
@Override
public @NonNull CommandArgument<@NonNull C, @NonNull Location> build() {
return new LocationArgument<>(
this.isRequired(),
this.getName(),
this.getDefaultValue(),
this.getSuggestionsProvider(),
this.getDefaultDescription(),
new LinkedList<>()
);
}
}
public static final class LocationParser implements ArgumentParser {
private static final int EXPECTED_PARAMETER_COUNT = 3;
private final LocationCoordinateParser locationCoordinateParser = new LocationCoordinateParser<>();
@Override
public @NonNull ArgumentParseResult<@NonNull Location> parse(
final @NonNull CommandContext<@NonNull C> commandContext,
final @NonNull Queue<@NonNull String> inputQueue
) {
if (inputQueue.size() < 3) {
final StringBuilder input = new StringBuilder();
for (int i = 0; i < inputQueue.size(); i++) {
input.append(((LinkedList) inputQueue).get(i));
if ((i + 1) < inputQueue.size()) {
input.append(" ");
}
}
return ArgumentParseResult.failure(
new LocationParseException(
commandContext,
LocationParseException.FailureReason.WRONG_FORMAT,
input.toString()
)
);
}
final LocationCoordinate[] coordinates = new LocationCoordinate[3];
for (int i = 0; i < 3; i++) {
final ArgumentParseResult<@NonNull LocationCoordinate> coordinate = this.locationCoordinateParser.parse(
commandContext,
inputQueue
);
if (coordinate.getFailure().isPresent()) {
return ArgumentParseResult.failure(
coordinate.getFailure().get()
);
}
coordinates[i] = coordinate.getParsedValue().orElseThrow(NullPointerException::new);
}
final Location originalLocation;
final CommandSender bukkitSender = commandContext.get(BukkitCommandContextKeys.BUKKIT_COMMAND_SENDER);
if (bukkitSender instanceof BlockCommandSender) {
originalLocation = ((BlockCommandSender) bukkitSender).getBlock().getLocation();
} else if (bukkitSender instanceof Entity) {
originalLocation = ((Entity) bukkitSender).getLocation();
} else {
originalLocation = new Location(Bukkit.getWorlds().get(0), 0, 0, 0);
}
if (((coordinates[0].getType() == LocationCoordinateType.LOCAL)
!= (coordinates[1].getType() == LocationCoordinateType.LOCAL))
|| ((coordinates[0].getType() == LocationCoordinateType.LOCAL)
!= (coordinates[2].getType() == LocationCoordinateType.LOCAL))
) {
return ArgumentParseResult.failure(
new LocationParseException(
commandContext,
LocationParseException.FailureReason.MIXED_LOCAL_ABSOLUTE,
""
)
);
}
if (coordinates[0].getType() == LocationCoordinateType.ABSOLUTE) {
originalLocation.setX(coordinates[0].getCoordinate());
} else if (coordinates[0].getType() == LocationCoordinateType.RELATIVE) {
originalLocation.add(coordinates[0].getCoordinate(), 0, 0);
}
if (coordinates[1].getType() == LocationCoordinateType.ABSOLUTE) {
originalLocation.setY(coordinates[1].getCoordinate());
} else if (coordinates[1].getType() == LocationCoordinateType.RELATIVE) {
originalLocation.add(0, coordinates[1].getCoordinate(), 0);
}
if (coordinates[2].getType() == LocationCoordinateType.ABSOLUTE) {
originalLocation.setZ(coordinates[2].getCoordinate());
} else if (coordinates[2].getType() == LocationCoordinateType.RELATIVE) {
originalLocation.add(0, 0, coordinates[2].getCoordinate());
} else {
final Vector declaredPos = new Vector(
coordinates[0].getCoordinate(),
coordinates[1].getCoordinate(),
coordinates[2].getCoordinate()
);
return ArgumentParseResult.success(
toLocalSpace(originalLocation, declaredPos)
);
}
return ArgumentParseResult.success(
originalLocation
);
}
static @NonNull Location toLocalSpace(final @NonNull Location originalLocation, final @NonNull Vector declaredPos) {
final double cosYaw = Math.cos(toRadians(originalLocation.getYaw() + 90.0F));
final double sinYaw = Math.sin(toRadians(originalLocation.getYaw() + 90.0F));
final double cosPitch = Math.cos(toRadians(-originalLocation.getPitch()));
final double sinPitch = Math.sin(toRadians(-originalLocation.getPitch()));
final double cosNegYaw = Math.cos(toRadians(-originalLocation.getPitch() + 90.0F));
final double sinNegYaw = Math.sin(toRadians(-originalLocation.getPitch() + 90.0F));
final Vector zModifier = new Vector(cosYaw * cosPitch, sinPitch, sinYaw * cosPitch);
final Vector yModifier = new Vector(cosYaw * cosNegYaw, sinNegYaw, sinYaw * cosNegYaw);
final Vector xModifier = zModifier.crossProduct(yModifier).multiply(-1);
final double xOffset = dotProduct(declaredPos, xModifier.getX(), yModifier.getX(), zModifier.getX());
final double yOffset = dotProduct(declaredPos, xModifier.getY(), yModifier.getY(), zModifier.getY());
final double zOffset = dotProduct(declaredPos, xModifier.getZ(), yModifier.getZ(), zModifier.getZ());
return originalLocation.add(xOffset, yOffset, zOffset);
}
private static double dotProduct(final Vector location, final double x, final double y, final double z) {
return location.getX() * x + location.getY() * y + location.getZ() * z;
}
private static float toRadians(final float degrees) {
return degrees * (float) Math.PI / 180f;
}
@Override
public @NonNull List<@NonNull String> suggestions(
final @NonNull CommandContext commandContext,
final @NonNull String input
) {
return LocationArgument.LocationParser.getSuggestions(commandContext, input);
}
static @NonNull List<@NonNull String> getSuggestions(
final @NonNull CommandContext commandContext,
final @NonNull String input
) {
final String workingInput;
final String prefix;
if (input.startsWith("~") || input.startsWith("^")) {
prefix = Character.toString(input.charAt(0));
workingInput = input.substring(1);
} else {
prefix = "";
workingInput = input;
}
return IntegerArgument.IntegerParser.getSuggestions(
Integer.MIN_VALUE,
Integer.MAX_VALUE,
workingInput
).stream().map(string -> prefix + string).collect(Collectors.toList());
}
@Override
public int getRequestedArgumentCount() {
return EXPECTED_PARAMETER_COUNT;
}
}
static class LocationParseException extends ParserException {
private static final long serialVersionUID = -3261835227265878218L;
protected LocationParseException(
final @NonNull CommandContext context,
final @NonNull FailureReason reason,
final @NonNull String input
) {
super(
LocationParser.class,
context,
reason.getCaption(),
CaptionVariable.of("input", input)
);
}
/**
* Reasons for which location parsing may fail
*/
public enum FailureReason {
WRONG_FORMAT(BukkitCaptionKeys.ARGUMENT_PARSE_FAILURE_LOCATION_INVALID_FORMAT),
MIXED_LOCAL_ABSOLUTE(BukkitCaptionKeys.ARGUMENT_PARSE_FAILURE_LOCATION_MIXED_LOCAL_ABSOLUTE);
private final Caption caption;
FailureReason(final @NonNull Caption caption) {
this.caption = caption;
}
/**
* Get the caption used for this failure reason
*
* @return The caption
*/
public @NonNull Caption getCaption() {
return this.caption;
}
}
}
}