Class PositionArguments

java.lang.Object

fr.robie.machineengine.api.paper.PositionArguments

public final class PositionArguments
extends Object

Optional [<x y z>] [<world>] arguments that default to the player running the command. Coordinates accept ~ (relative to the executor); the world is a name (world) or a key (minecraft:overworld) and defaults to the executor's world. Without coordinates, a player uses the PositionArguments.Default position; the console must give them.

Brigadier types only, so any command library can use it (D35): add positionArgument() then worldArgument() as optional arguments and call resolve(CommandContext, PositionArguments.Default) when the command runs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PositionArguments.Default	What a player's position defaults to when no coordinates are given.
static final record	PositionArguments.Position	A command position: a world and block coordinates.

Method Summary

Modifier and Type	Method	Description
static @NotNull com.mojang.brigadier.builder.RequiredArgumentBuilder<io.papermc.paper.command.brigadier.CommandSourceStack, io.papermc.paper.command.brigadier.argument.resolvers.BlockPositionResolver>	positionArgument()	The <x y z> argument; resolve(CommandContext, PositionArguments.Default) reads it.
static @Nullable PositionArguments.Position	resolve(@NotNull com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context, @NotNull PositionArguments.Default fallback)	The position a command was run for: its positionArgument() and worldArgument(), else fallback for a player.
static @Nullable org.bukkit.World	world(@NotNull String name)	A world by name (world) or key (minecraft:overworld).
static @NotNull com.mojang.brigadier.builder.RequiredArgumentBuilder<io.papermc.paper.command.brigadier.CommandSourceStack, String>	worldArgument()	The <world> argument (rest of the line, world names suggested), after positionArgument().

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

positionArgument

@NotNull
public static @NotNull com.mojang.brigadier.builder.RequiredArgumentBuilder<io.papermc.paper.command.brigadier.CommandSourceStack, io.papermc.paper.command.brigadier.argument.resolvers.BlockPositionResolver> positionArgument()

The <x y z> argument; resolve(CommandContext, PositionArguments.Default) reads it.

worldArgument

@NotNull
public static @NotNull com.mojang.brigadier.builder.RequiredArgumentBuilder<io.papermc.paper.command.brigadier.CommandSourceStack, String> worldArgument()

The <world> argument (rest of the line, world names suggested), after positionArgument().

resolve

@Nullable
public static @Nullable PositionArguments.Position resolve(@NotNull
 @NotNull com.mojang.brigadier.context.CommandContext<io.papermc.paper.command.brigadier.CommandSourceStack> context,
 @NotNull
 @NotNull PositionArguments.Default fallback)

The position a command was run for: its positionArgument() and worldArgument(), else fallback for a player.

Returns:

the position, or null after telling the sender what is wrong (console without coordinates, unknown world, nothing looked at, invalid coordinates)

world

@Nullable
public static @Nullable org.bukkit.World world(@NotNull
 @NotNull String name)

A world by name (world) or key (minecraft:overworld).