Package cloud.commandframework.fabric.argument.server

Class BlockPosArgument<C>

java.lang.Object
cloud.commandframework.arguments.CommandArgument<C,Coordinates.BlockCoordinates>
cloud.commandframework.fabric.argument.server.BlockPosArgument<C>
Type Parameters:
C - the sender type
All Implemented Interfaces:
cloud.commandframework.keys.CloudKeyHolder<Coordinates.BlockCoordinates>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>
public final class BlockPosArgument<C> extends cloud.commandframework.arguments.CommandArgument<C,Coordinates.BlockCoordinates>
An argument for resolving Coordinates.BlockCoordinates.
Since:
1.5.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    BlockPosArgument.Builder<C>
    Builder for BlockPosArgument.

    Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

    cloud.commandframework.arguments.CommandArgument.TypedBuilder<C extends Object,T extends Object,B extends cloud.commandframework.arguments.CommandArgument.Builder<C,T>>

  • Method Summary

    Modifier and Type
    Method
    Description
    static <C> @NonNull BlockPosArgument.Builder<C>
    builder(@NonNull String name)
    Create a new BlockPosArgument.Builder.
    static <C> @NonNull BlockPosArgument<C>
    of(@NonNull String name)
    Create a new required BlockPosArgument.
    static <C> @NonNull BlockPosArgument<C>
    optional(@NonNull String name)
    Create a new optional BlockPosArgument.
    static <C> @NonNull BlockPosArgument<C>
    optional(@NonNull String name, @NonNull net.minecraft.core.BlockPos defaultValue)
    Create a new optional BlockPosArgument with the specified default value.

    Methods inherited from class cloud.commandframework.arguments.CommandArgument

    addPreprocessor, compareTo, copy, equals, getDefaultDescription, getDefaultValue, getKey, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • builder

      public static <C> @NonNull BlockPosArgument.Builder<C> builder(@NonNull String name)
      Create a new BlockPosArgument.Builder.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Name of the argument
      Returns:
      Created builder
      Since:
      1.5.0

    • of

      public static <C> @NonNull BlockPosArgument<C> of(@NonNull String name)
      Create a new required BlockPosArgument.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Component name
      Returns:
      Created argument
      Since:
      1.5.0

    • optional

      public static <C> @NonNull BlockPosArgument<C> optional(@NonNull String name)
      Create a new optional BlockPosArgument.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Component name
      Returns:
      Created argument
      Since:
      1.5.0

    • optional

      public static <C> @NonNull BlockPosArgument<C> optional(@NonNull String name, @NonNull net.minecraft.core.BlockPos defaultValue)
      Create a new optional BlockPosArgument with the specified default value.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Component name
      defaultValue - default value
      Returns:
      Created argument
      Since:
      1.5.0