Package cloud.commandframework.fabric.argument.server

Class ColumnPosArgument<C>

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

  • Nested Class Summary

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

    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 ColumnPosArgument.Builder<C>
    builder(@NonNull String name)
    Create a new ColumnPosArgument.Builder.
    static <C> @NonNull ColumnPosArgument<C>
    of(@NonNull String name)
    Create a new required ColumnPosArgument.
    static <C> @NonNull ColumnPosArgument<C>
    optional(@NonNull String name)
    Create a new optional ColumnPosArgument.
    static <C> @NonNull ColumnPosArgument<C>
    optional(@NonNull String name, @NonNull net.minecraft.core.BlockPos defaultValue)
    Create a new optional ColumnPosArgument 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 ColumnPosArgument.Builder<C> builder(@NonNull String name)
      Create a new ColumnPosArgument.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 ColumnPosArgument<C> of(@NonNull String name)
      Create a new required ColumnPosArgument.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Component name
      Returns:
      Created argument
      Since:
      1.5.0

    • optional

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

    • optional

      public static <C> @NonNull ColumnPosArgument<C> optional(@NonNull String name, @NonNull net.minecraft.core.BlockPos defaultValue)
      Create a new optional ColumnPosArgument with the specified default value.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Component name
      defaultValue - default value, y coordinate will be ignored as it is always 0
      Returns:
      Created argument
      Since:
      1.5.0