Package cloud.commandframework.fabric.argument

Class NbtTagArgument<C>

java.lang.Object
cloud.commandframework.arguments.CommandArgument<C,net.minecraft.nbt.Tag>
cloud.commandframework.fabric.argument.NbtTagArgument<C>
Type Parameters:
C - the sender type
All Implemented Interfaces:
cloud.commandframework.keys.CloudKeyHolder<net.minecraft.nbt.Tag>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>
public final class NbtTagArgument<C> extends cloud.commandframework.arguments.CommandArgument<C,net.minecraft.nbt.Tag>
An argument for the string representation of an NBT Tag.
Since:
1.5.0

  • Nested Class Summary

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

    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 NbtTagArgument.Builder<C>
    builder(@NonNull String name)
    Create a new NbtTagArgument.Builder.
    static <C> @NonNull NbtTagArgument<C>
    of(@NonNull String name)
    Create a new required NbtTagArgument.
    static <C> @NonNull NbtTagArgument<C>
    optional(@NonNull String name)
    Create a new optional NbtTagArgument.
    static <C> @NonNull NbtTagArgument<C>
    optional(@NonNull String name, @NonNull net.minecraft.nbt.Tag defaultTag)
    Create a new optional NbtTagArgument 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 NbtTagArgument.Builder<C> builder(@NonNull String name)
      Create a new NbtTagArgument.Builder.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Name of the component
      Returns:
      Created builder
      Since:
      1.5.0

    • of

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

    • optional

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

    • optional

      public static <C> @NonNull NbtTagArgument<C> optional(@NonNull String name, @NonNull net.minecraft.nbt.Tag defaultTag)
      Create a new optional NbtTagArgument with the specified default value.
      Type Parameters:
      C - Command sender type
      Parameters:
      name - Component name
      defaultTag - Default tag value
      Returns:
      Created component
      Since:
      1.5.0