Package cloud.commandframework.fabric.argument

Class AxisArgument<C>

java.lang.Object
cloud.commandframework.arguments.CommandArgument<C,EnumSet<net.minecraft.core.Direction.Axis>>
cloud.commandframework.fabric.argument.AxisArgument<C>
Type Parameters:
C - the sender type
All Implemented Interfaces:
cloud.commandframework.keys.CloudKeyHolder<EnumSet<net.minecraft.core.Direction.Axis>>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>
public final class AxisArgument<C> extends cloud.commandframework.arguments.CommandArgument<C,EnumSet<net.minecraft.core.Direction.Axis>>
An argument for a set of axes, described in Vanilla as a "swizzle".
Since:
1.5.0

  • Nested Class Summary

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

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

    • optional

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

    • optional

      public static <C> @NonNull AxisArgument<C> optional(@NonNull String name, @NonNull Set<@NonNull net.minecraft.core.Direction.Axis> defaultValue)
      Create a new optional AxisArgument with the specified default value.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Argument name
      defaultValue - Default axes to include
      Returns:
      Created argument
      Since:
      1.5.0